Маршруты и аутентификация
Для обеспечение интеграции со внешними системами, необходимо настроить отправку запросов на адрес сервера кол-трекинг. Адрес сервера выдается по запросу технической командой кол-трекинг.
| Тип данных | Способ получения |
| URL | Выдается по запросу, технической службой кол-трекинг |
Для обеспечения аутентификации используется токен аутентификации и имя провайдера:
| Параметр | Способ получения |
| provider_auth_token | Выдается по запросу, технической службой кол-трекинг |
| provider_name | Выдается по запросу, технической службой кол-трекинг |
Структура запросов
В работе с хостами в API используются запросы трёх типов:
- user_host_create - для добавления новых хостов
- user_host_update - для редактирования хостов у пользователей
- user_host_delete - для удаления хостов
- user_host_read - для получения данных о хосте
Данные передаются в формате JSON. Ниже представлено описание основных параметров, которые должны быть включены в запрос:
user_host_create
POST /api/v1/user_host
*Все параметры являются обязательными.
Пример запроса:
{
"provider_name": "Provider",
"provider_auth_token": "123dflmsdvpm123",
"user_uid": "180d6265-f3f3-40d1-9de7-ddec10f2af9d",
"hosts": ["example.tld"]
}Пример ответа:
{
"status_code": 201,
"status": "Created",
"host_id": 3
} user_host_read
GET /api/v1/users/:user_uuid/user_hosts/
*Все параметры являются обязательными.
Пример запроса:
api/v1/users/fe434415-0bf1-4d89-bb6e-91ffb5ec1098/user_hosts/3?provider_name=NAME&provider_auth_token=TOKEN
Пример ответа:
{
"status_code": 200,
"status": "OK",
"user_hosts": [{
"user_host_id": 3,
"hosts": ["example.tld"]
}]
}user_host_delete
DELETE /api/v1/users/:user_uuid/user_hosts/:id
*Все параметры являются обязательными.
Пример запроса:
api/v1/users/fe434415-0bf1-4d89-bb6e-91ffb5ec1098/user_hosts/3?provider_name=NAME&provider_auth_token=TOKEN
Пример ответа:
{
"status_code": 200,
"status": "OK"
}