Codestin Search App

Способы вызова операций

POST https://api.mindbox.ru/v3/operations/sync?endpointId={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}&deviceUUID={уникальный идентификатор устройства}

Authorization: SecretKey {Секретный ключ}
Accept: application/json
Content-Type: application/json
X-Customer-IP: {Ip адрес устройства потребителя, обязательность уточнить у менеджера}

POST https://api.mindbox.ru/v3/operations/async?endpointId={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}&deviceUUID={уникальный идентификатор устройства}

Authorization: Mindbox secretKey="{секретный ключ, обязательность уточнить у менеджера}"
Accept: application/xml
Content-Type: application/xml
X-Customer-IP: {Ip адрес устройства потребителя, обязательность уточнить у менеджера}

POST https://api.mindbox.ru/v3/operations/bulk?endpointId={уникальный идентификатор сайта и т.п.}&operation={название операции}

Authorization: Mindbox secretKey="{секретный ключ}"
Accept: application/json
Content-Type: text/csv;charset=utf-8

EndpointId

Уникальный идентификатор сайта/мобильного приложения/и т.п.
Значение нужно уточнить у менеджера.

Заголовок Authorization

Наличие заголовка 'Authorization' зависит от операции.
Необходимость нужно уточнить у менеджера.
Каждому EndpointId соответствует свой secretKey, значение нужно уточнить у менеджера.

Operation

Название операции в Майндбокс. Каждому типу действия на сайте/на кассе/мобильном приложении соответствует своя операция.
Список операций настраивается в системе.
Формат тела запроса и ответа, различается в зависимости от типа операции.

DeviceUUID

Обязательность нужно уточнить у менеджера

для сайта, нужно передать DeviceUUID из куки mindboxDeviceUUID
для Android нужно получить значение через метод SDK subscribeDeviceUuid
для iOS нужно получить значение через метод SDK getDeviceUUID

Формат тела запроса

В зависимости от заголовка Content-Type данные в теле запроса могут приниматься либо в формате XML, либо в формате JSON.
Тело запроса должно быть в кодировке UTF-8.

Формат тела ответа

В зависимости от заголовка Accept ответ сервиса будет либо в формате XML, либо в формате JSON.
Тело ответа возвращается в кодировке UTF-8. Ключи в ответе возвращаются в стиле написания camel case, даже если дополнительные поля имеют системное имя в верхнем регистре.