Удаление импортированных данных

Читать 4

Описание

API-метод позволяет удалять импорты, отображаемые в разделе:
Интеграции /  Рекламные системы / Импорт данных / вкладка "Лог":


Запрос

POST: 

https://api.calltouch.ru/report-service/RestAPI/api/users-import/delete

HTTP-заголовки:

  • Access-Token — API-ключ:
  • SiteId — ID ЛК Calltouch.

Тело запроса в формате JSON.

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

{
"importLogIds": [ID_импорта_1, ID_импорта_2, ID_импорта_N]
}

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

На вход подается только список ID импортов. В одном запросе можно указать не более 100 импортов. Получить идентификаторы можно двумя способами:

  1. В ответе на успешный API-запрос импорта расходов или импорта плановых метрик;
  2. В интерфейсе Личного кабинета Calltouch, раздел: Интеграции /  Рекламные системы / Импорт данных / вкладка "Лог":


Ответ

Процесс удаления запускается сразу после отправки запроса, после чего сразу возвращается и ответ.

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

{
"meta": [],
"data": {
"importLogs": [
{
"importLogId": 123,
"deleteStatus": "success",
"error": null
},
{
"importLogId": 124,
"deleteStatus": "success",
"error": null
}
 ]
 }
 }

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

Параметр Формат Описание
data.importLogs[n].importLogId integer Переданный ID сделки из внешний CRM в запросе на обновление.
data.importLogs[n].deleteStatus string

Статус удаления. Возможные значения:

  • success
  • error
data.importLogs[n].error object Отображается причина ошибки удаления

Типовые ошибки

1. Ошибка авторизации 

{

 "meta": [],

 "data": {

 "message": "Ошибка доступа"

 }

}

2. Ошибка формата тела запроса 

{
"meta": [],
"data": {
"type": "apiError",
"apiErrorData": {
"errorCode": 1,
"errorMessage": "Синтаксическая ошибка JSON в запросе или запрос пустой",
"errorDescription": null
},
"validationErrorData": null
}
}

3. Отсутствие обязательных полей в запросе 

{
"meta": [],
"data":
{
"message": "В запросе не указано обязательное поле \"importLogIds\""
}
}

4. Невалидный элемент массива 

{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"fieldPath": "importLogIds[2]",
"message": "Невалидное значение."
}
]
}
}
}

5. Один из идентификаторов не найден 

{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"importLogId": 123,
"deleteStatus": "success",
"error": null
},
{
"importLogId": 124,
"deleteStatus": "error",
"error": "Указанный идентификатор импорта не найден."
}
]
}
}
}

Система баллов API Calltouch

Система баллов API - механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов. За каждый успешно выполненный запрос списываются баллы. Подробнее читайте в статье: Система баллов API Calltouch.

Количество запросов в секунду к API Calltouch ограничено – не более 5 запросов в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, а остальные API-запросы завершатся с ошибкой c кодом 429 (Too Many Requests).



Не нашли решение проблемы?
Заполните форму, и мы вам поможем.
Похожие статьи
Недавно просмoтренные