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

API

На вкладке «API» вы можете настроить некоторые параметры для интеграций по API.

Параметры API

Настройки API​

  • TimeSpan как строка:

    • — параметр TimeSpan возвращается в формате по умолчанию;
    • — возвращается форматированное значение параметра TimeSpan.

  • DateTime как строка:

    • — параметр DateTime возвращается в формате по умолчанию;
    • — возвращается форматированное значение параметра DateTime (формат задается через дизайнер параметров в настройках объекта мониторинга).

  • Device как строка:

    • — возвращается уникальный идентификатор (Guid) объекта мониторинга;
    • — возвращается наименование объекта мониторинга.

  • Driver как строка:

    • — возвращается уникальный идентификатор (Guid) водителя;
    • — возвращается описание текущего статуса водителя (поле description).

  • Geofence как строка:

    • — возвращается уникальный идентификатор (Guid) геозоны;
    • — возвращается наименование геозоны.

  • Implement как строка:

    • — возвращается уникальный идентификатор (Guid) инструмента;
    • — возвращается наименование инструмента.

  • Task как строка:

    • — возвращается уникальный идентификатор (Guid) задачи;
    • — возвращается наименование задачи.

  • Guid как массив:

    • — возвращается значение первого объекта Guid;
    • — возвращается массив объектов Guid до появления пустого значения (может вернуть от 0 до 4 значений).

  • GetStages: искать отрезок по алиасу — поиск отрезка через запрос GetStage по псевдониму параметра.

  • GetStages: искать отрезок по имени — поиск отрезка через запрос GetStage по наименованию параметра.

примечание

Настройка запроса GetStage зависит от комбинации приведенных чек-боксов:

  • выставлены или не выставлены оба чек-бокса GetStages — поиск отрезка и по наименованию, и по псевдониму параметра;
  • выставлен только чек-бокс «GetStages: искать отрезок по алиасу» — поиск отрезка только по псевдониму параметра;
  • выставлен только чек-бокс «GetStages: искать отрезок по имени» — поиск отрезка только по наименованию параметра.
  • Имя параметра в новом формате:
    • — формат имени параметра: имя параметра пробел тип параметра;
    • — формат имени параметра: имя параметра тип параметра.

Ограничения запросов API​

При высокой нагрузке на сервер программы целесообразно ввести ограничения на количество запросов API и на объем данных в этих запросах.

Активируйте ограничения, выставив чек-бокс «Включить ограничения», и подберите такие значения для ограничений, которые снизят нагрузку на сервер программы, не влияя при этом на работоспособность интеграций по API:

осторожно

Слишком низкие значения ограничений могут привести к неработоспособности реализованных ранее интеграций по API.

предупреждение

При наличии интеграций по API рекомендуется (до обращения в службу технической поддержки по вопросам высокой загруженности сервера программы) установить значение 1 для ограничения «Одновременных запросов пользователя» и проверить работоспособность программы.

  • Одновременных запросов по схеме — максимально допустимое количество одновременных запросов для одной схемы.
  • Одновременных запросов пользователя — максимально допустимое количество одновременных запросов от одного пользователя (рекомендованное значение — 1).
  • Максимальное количество объектов мониторинга в запросе — максимально допустимое количество объектов мониторинга в запросе.
  • Максимальное количество машинодней мониторинга в запросе — максимально допустимое количество машино-дней в запросе (рекомендованное значение для начала подбора — 1000).
примечание

Машино-день является результатом умножения количества транспортных средств (объектов мониторинга) на количество суток в запрошенном периоде времени.