F ForestAPI
Developer Reference • REST API • JSON Exchange

API документация ForestAPI

Базовая справочная информация для интеграции телеметрических модулей, диспетчерских сервисов и внутренних производственных систем с платформой ForestAPI.

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

Базовый URL https://forestapi.ru/api/v1
Формат обмена JSON
Авторизация Bearer Token
Основной endpoint /sync
Назначение Синхронизация телеметрии и производственных событий

Поддерживаемые сценарии

  • передача координат и статусов техники;
  • синхронизация событий по заправкам и топливу;
  • передача сменных и производственных обновлений;
  • интеграция с внутренними ERP и учетными модулями;
  • журналирование событий и диспетчерских операций.
API status: operational

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

Типовой запрос на передачу телеметрического события в синхронизационный контур:

POST /api/v1/sync HTTP/1.1
Host: forestapi.ru
Authorization: Bearer <token>
Content-Type: application/json

{
  "assetId": "KOMATSU-PC200-08",
  "timestamp": "2026-04-02T12:00:00Z",
  "location": {
    "lat": 61.7891,
    "lon": 34.3527
  },
  "fuelLevel": 72,
  "event": "shift_update"
}

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

При успешной обработке события сервис возвращает подтверждение приема:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": true,
  "status": "accepted",
  "eventId": "evt_20260402_120000_001",
  "receivedAt": "2026-04-02T12:00:01Z"
}

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

Если токен отсутствует или недействителен, сервис возвращает ответ авторизации:

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "service": "ForestAPI",
  "endpoint": "/api/v1/sync",
  "status": "unauthorized",
  "code": 401,
  "message": "Missing or invalid authorization token"
}

Требования к интеграции

  • передача данных выполняется по HTTPS;
  • тело запроса должно быть в формате JSON;
  • метка времени передается в UTC;
  • идентификаторы техники должны быть уникальны в контуре интеграции;
  • доступ к API предоставляется после регистрации интеграционного клиента.