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

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

Время начала текущего интервала строго фиксированное - начало астрономического часа (например, с 15:00 до 15:59). Каждый успешный вызов метода API Calltouch влечет списание определенного количества баллов. При исчерпании почасового лимита вызов методов будет прекращен до наступления следующего часа. Доступные суточные и почасовые баллы отображаются в разделе  Интеграции /  Отправка данных во внешние системы => API и Webhooks:

Расчет количества суточных баллов осуществляется раз в сутки, они выдаются в 00:00. Неизрасходованные баллы за предыдущие сутки обнуляются.
Баллы, доступные для текущего часа, начисляются в начале текущего часа. Неизрасходованные баллы за предыдущий час обнуляются.

За каждый успешно выполненный запрос списываются баллы в зависимости от стоимости метода и от кол-ва объектов. Ниже представлена таблица с методами API и количеством баллов за использование каждого:

В ответах API можно узнать:

• количество оставшихся баллов после выполнения метода;
• ошибки, связанные с исчерпанием баллов.

Подробная информация указана ниже.

HTTP-заголовок с баллами

Во всех описанных методах транслируется HTTP-заголовок Api-Point. Заполнятся по формату:

Api-Point: потраченное количество баллов за запрос/оставшееся количество почасовых баллов/оставшееся количество суточных баллов

Пример сформированного заголовка:

Api-Point: 4/5256/102368

При исчерпании часовых баллов транслируется ошибка (HTTP-код ответа - 429) с текстом:

 {
     "meta": [],
     "data": {
             "type": "apiError",
             "apiErrorData": {
                              "errorCode": 90001,
                              "errorMessage": "Исчерпан часовой лимит баллов по сайту",
                              "errorDescription": null
             },
             "validationErrorData": null
     } 
 }