Appearance
Список каналов для оценки NPS
Метод возвращает список всех настроенных каналов для оценки NPS. Как правило, на сайте и в приложении он не используется, т.к. программист хардкодит код канала в форме сбора отзыва в зависимости от того, где находится форма (сайт, письмо, мобильное приложение, устройство на кассе и пр.).
GET https://api.rees46.ru/nps/channelsПараметры
| Параметр | Тип | Обязателен? | Описание |
|---|---|---|---|
| shop_id | String | Да | API-ключ |
Запрос
Пример запроса:
shell
curl "https://api.rees46.ru/nps/channels?shop_id=..."Ответ
Пример ответа сервера:
json
[
{
"name": "...",
"code": "..."
},
{
"name": "...",
"code": "..."
}
]Внимание
В будущем структура будет приведена к стандарту ответа:
json
{
"status": "success",
"payload": {
"channels": [
{
"name": "...",
"code": "..."
},
{
"name": "...",
"code": "..."
}
]
}
}Рекомендуем подготовить обработчик ответа под новую структуру, чтобы ваша интеграция не сломалась.
Расшифровка свойств ответа:
| Свойство | Тип | Описание |
|---|---|---|
| name | String | Название канала |
| code | String | Уникальный код канала |
Если каналов нет, вернется пустой массив.
В случае ошибки тело ответа пустое, причину нужно определять по HTTP-коду:
| Код | Причина |
|---|---|
| 404 | Параметр shop_id не передан |
| 403 | API-ключ неверен или магазин деактивирован |