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

Описание API

Общие сведения​

Описание методов API вы можете посмотреть, выбрав Меню "Информация" | AutoGRAPH API| на рабочем столе программы АвтоГРАФ.WEB.

AutoGRAPH API

Откроется список разделов API-функций. В каждом разделе приведены названия API-функций с краткими описаниями и методами запроса на получение данных GET и POST.

На этой же платформе вы можете выполнить проверку запросов API.
Для работы с АвтоГРАФ.WEB API необходимо авторизоваться под пользователем, которому доступна работа с API и получить токен доступа, который будет использоваться во всех последующих API-запросах.

Убедитесь, что в настройках роли используемой учетной записи включено право "Доступ через API".

AutoGRAPH API

Подробнее о работе с API см. в статье "АвтоГРАФ.WEB: Интеграция со сторонними системами с помощью API"

Инструкция по работе с API​

API предоставляет доступ к расчётному ядру ПО АвтоГРАФ.WEB и позволяет получить как данные по структуре схемы (объекты мониторинга, геозоны, водители, инструменты, параметры и т.д.), так и рассчитанные данные по объектам мониторинга за произвольные периоды в разных видах.

При работе с API необходимо соблюдать следующие правила​

  • Запросы к сервису должны быть аутентифицированы с помощью токена, который получается с помощью метода Login. Данный токен должен передаваться либо в query string с названием session, либо в http header с названием AG-Token.
  • API поддерживает методы GET и POST.
  • API умеет принимать данные как в query string (GET), так и в body (POST) в виде wwwform/urlencoded или application/json. Второй способ предпочтителен, когда используется большое количество данных (например, список из сотен геозон).
  • Все запросы имеют обязательный параметр schemaID, содержащий ID схемы, в контексте которого выполняется запрос (исключение — схемонезависимые запросы типа GetRoute)
  • Права доступа, ограничения на аккаунт, на список объектов, период и т.д. — берутся сервером из настроек аккаунта, под которым выполнялся Login.
  • На данный момент сервером выдается бессрочный токен, однако следует делать Login для получения токена перед каждым пакетом запросов. Выполнение данного метода никак не влияет на загрузку сервера, однако позволяет гарантировать, что токен актуален.
  • Если необходимо выполнить ряд однотипных запросов (например, получение рейсов по списку объектов мониторинга), имеет смысл выполнить один запрос с передачей списка ID, чем отправлять одновременно все запросы по всем этим объектам.

Соглашения по структуре объектов​

  • Каждый объект типа "объект мониторинга", "геозона", "водитель", "инструмент" и "задача" имеет уникальный идентификатор (ID).
  • Гарантируется уникальность ID объектов и их групп в пределах схемы и типа объектов. То есть все объекты мониторинга и их группы будут иметь уникальные ID.
  • Объект получает ID в момент создания и на протяжении жизни объекта он никогда не меняется. При переносе объекта между группами его ID сохраняется.
  • На данный момент в качестве ID объектов используется GUID в виде 36-символьной регистронезависимой строки. Следует рассматривать этот ID только как регистронезависимую строку, не делая предположений, что данный формат (GUID) сохранится в будущем. Однако гарантируется, что максимальная длина ID объекта не будет более 36 символов.
  • Если в запросе присутствует в качестве параметра список ID, в нем всегда поддерживаются передача как ID групп, так и отдельных объектов. Если передан ID группы, то будет выполнен запрос так, как будто в него передали полный список ID всех вложенных объектов и подгрупп этой группы.
Была ли статья полезна?

Помогите нам улучшить статью, оставив обратную связь.