Авторизация

  • /auth - получение сессионного ключа доступа
  • /signup - регистрация нового пользователя

Звонки

Заказы

Функция /auth

Функция позволяет получить пользовательский сессионный ключ доступа к API.

Входные параметры:

Параметр Назначение
email* Адрес электронной почты пользователя
password* Пароль пользователя

Пример вызова:

{
  "email": "test@test.ru",
  "password": "foobar"
}

Возвращаемые значения:

Параметр Назначение
token Сессионный ключ доступа для API v2.0
legacy Данные, использующиеся для авторизации в предыдущих версиях системы. Массив состоящий из двух полей: affid и security, где affid - идентификатор пользователя, а security - хэшированный пароль. Для корректной работы устаревших частей системы, эти два параметра должны быть сохранены в одноименных cookie.

Пример:

{
    "token": "27a6e9abc4b2bb0bab2ffadfef915ae86bc",
    "legacy": {
        "affid": 27,
        "security": "6e9abc4b2bb0bab2ffadfef915ae86bc"
    }
}

Возможные ошибки:

Код Константа Описание
1 ERROR_EMAIL_REQUIRED Необходимо указать e-mail
2 ERROR_PASSWORD_REQUIRED Необходимо указать пароль
3 ERROR_EMAIL_INVALID Неверный e-mail адрес
7 ERROR_DATABASE Ошибка базы данных
8 ERROR_ACCESS_DENIED Доступ запрещен

Функция /signup

Функция позволяет зарегистрировать в системе нового пользователя.

Входные параметры:

Параметр Назначение Примечание
name* Имя пользователя
email* Адрес электронной почты
password* Пароль пользователя
captcha* reCAPTCHA g-recaptcha-response Для защиты от спама используется reCAPTCHA
sitekey="6LcEU8ISAAAAAAhA6dWEeQMfZD4_gOmTgdDLl9q-"
ref_id Идентификатор реферала

Функция /orders/new

Функция позволяет зарегистрировать в системе новый заказ.

Входные параметры:

Параметр Назначение Примечание
fname* Имя
lname* Фамилия
mname* Отчество
phone* Контактный телефон
email Адрес электронной почты
note Примечание к заказу
shop_id Идентификатор магазина Обязательный, если используется сессионный API Key
customer* Тип покупателя 1 - Физ.лицо
2 - Юр.лицо/ИП
paymethod* Способ оплаты 1 - Наличные
2 - Банковский платёж/безналичный расчёт
3 - Банковская карта (лично)
4 - Электронный платёж (Я.Деньги, Webmoney, QIWI и т.п.)
5 - Банковская карта (онлайн)
recievemethod* Способ получения 0 - Собственная курьерская служба
1 - Самовывоз с собственных пунктов выдачи
2 - Транспортная компания
address Адрес доставки Обязательно, для курьерской доставки
city Город доставки Обязательно, для доставок транспортными компаниями
emoney_details Идентификатор кошелька плательщика Обязательно, при оплате электронным платежом
individual_address Адрес прописки Обязательно, при доставке транспортной компанией на физ.лицо
transport_company_id Идентификатор транспортной компании 2 - ПЭК
3 - Деловые линии
4 - EMS Почта России
5 - СДЭК (возможна оплата при получении)
legal_name Наименование организации Обязательно, для покупателя юр.лица
legal_address Юридический адрес организации Обязательно, для покупателя юр.лица
legal_inn ИНН Обязательно, для покупателя юр.лица
legal_kpp КПП Обязательно, для покупателя юр.лица
legal_rs Расчётный счёт Обязательно, для покупателя юр.лица
legal_bank Банк, город Обязательно, для покупателя юр.лица
legal_ks Кор.счёт Обязательно, для покупателя юр.лица
legal_bik БИК Обязательно, для покупателя юр.лица
delivery_tariff_id Идентификатор индивидуального тарифа доставки Используется для функционала "Доставка за счёт партнера"
goods* Массив идентификаторов товаров заказа их количества См. примеры

Пример, самовывоз с ПВЗ, физ.лицо, оплата наличными:

{
    "token": "27a6e9abc4b2bb0bab2ffadfef915ae86bc",
    "fname": "Иван",
    "lname": "Иванов",
    "mname": "Иванович",
    "phone": "+79123456789",
    "note": "Подъедет на личном а/м, заказать заранее пропуск",
    "customer": 1,
    "paymethod": 1,
    "recievemethod": 1,
    "goods": [
      {
         "code": "hybrid-500",
         "quantity": 2,
      },
    ]
}

Пример, физ.лицо, оплата картой на сайте, доставка транспортной компанией ПЭК:

{
    "token": "27a6e9abc4b2bb0bab2ffadfef915ae86bc",
    "fname": "Пётр",
    "lname": "Петров",
    "mname": "Петрович",
    "phone": "+79876543219",
    "customer": 1,
    "paymethod": 2,
    "recievemethod": 2,
    "transport_company_id": 2,
    "city": "Воронеж",
    "individual_address": "Воронеж, ул.Стачек, д.15, кв.234",
    "goods": [
      {
         "code": "ibp-pro-500",
         "quantity": 1,
      },
      {
         "code": "akb-12-100",
         "quantity": 1,
      },
    ]
}

Пример, юр.лицо, курьерская доставка:

{
    "token": "27a6e9abc4b2bb0bab2ffadfef915ae86bc",
    "fname": "Сидор",
    "lname": "Сидоров",
    "mname": "Сидорович",
    "phone": "+79876543219",
    "customer": 2,
    "paymethod": 5,
    "recievemethod": 0,
    "address": "Санкт-Петербург, ул.Воронежская, д.31, офис 15",
    "legal_name": "ООО \"Рога и Копыта\"",
    "legal_address": "630108, Ленинградская обл., пос.Вешки, ул.Кленовая, д.11, офис 31",
    "legal_inn": "5428946287",
    "legal_kpp": "540505008",
    "legal_rs": "40702610807000001386",
    "legal_bank": "Банк Филиал №7701 БАНКА ВТБ (ПАО) г.Москва",
    "legal_ks": "30102810148270000795",
    "legal_bik": "044535745",
    "goods": [
      {
         "code": "ibp-pro-500",
         "quantity": 1,
      },
      {
         "code": "akb-12-100",
         "quantity": 1,
      },
    ]
}

Возвращаемые значения:

Параметр Назначение
order Объект, содержащий принятый заказ

Возможные ошибки:

Код Константа Описание
8 ERROR_ACCESS_DENIED Недействительный API Key
15 ERROR_INSUFFICIENT_DATA Не переданы необходимые данные
17 ERROR_INSUFFICIENT_DATA_SHOP Использован сессионный API Key, но не передано поле shop_id
16 ERROR_INSUFFICIENT_DATA_NAME Не указано имя покупателя