Перейти к основному содержимому

Управление клиентами

Клиент - содержит информацию о пользователе приложения. Добавление клиента осуществляется по клиентскому токену. Клиент содержит информацию о номере телефона и т.п.

Базовый адрес API https://api.multipushed.ru

Пропробуйте в Swagger

Аутентификация

Для всех методов используется аутентификация на основе Bearer токена, который можно получить в личном кабинете

Добавление клиента

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

POST https://api.multipushed.ru/v2/management/customer

тело запроса:

{
"operation": "Create",
"clientToken":"<clientToken>",
"phoneNumber": "<phoneNumber>"
}

Параметры тела запроса

operationCreate - тип операцииОбязательное поле
clientTokenКлиентский токенОбязательное поле
phoneNumberНомер телефона в формате 79999999999Обязательное поле

Пример запроса:

curl -v -X POST https://api.multipushed.ru/v2/management/customer
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <accessToken>'
-d '{ "operation": "Create", "clientToken":"<clientToken>", "phoneNumber": "phoneNumber"}'

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

В случае успеха

{
"success": true/false,
"errCode": int/null,
"message": string/null
}
successрезультат выполнения запроса
errCodeкод ошибки, будет заполнено в случае ошибки
messageтекстовое описание ошибки, будет заполнено в случае ошибки

Изменение клиента

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

POST https://api.multipushed.ru/v2/management/customer

тело запроса:

{
"operation": "Update",
"clientToken":"<clientToken>",
"phoneNumber": "<phoneNumber>"
}

Параметры тела запроса

operationUpdate - тип операцииОбязательное поле
clientTokenКлиентский токенОбязательное поле
phoneNumberНомер телефона в формате 79999999999Обязательное поле

Пример запроса:

curl -v -X POST https://api.multipushed.ru/v2/management/customer
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <accessToken>'
-d '{ "operation": "Update", "clientToken":"<clientToken>", "phoneNumber": "phoneNumber"}'

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

В случае успеха

{
"success": true/false,
"errCode": int/null,
"message": string/null
}
successрезультат выполнения запроса
errCodeкод ошибки, будет заполнено в случае ошибки
messageтекстовое описание ошибки, будет заполнено в случае ошибки