F ForestAPI
Home Sign In
Developer Reference • REST API • JSON Exchange

ForestAPI Documentation

Core integration reference for telemetry modules, dispatch services, and internal operational systems connected to the ForestAPI platform.

Request Access Service Status

General Information

Base URL https://forestapi.su/api/v1
Exchange Format JSON
Authorization Bearer Token
Primary Endpoint /sync
Purpose Telemetry and operational event synchronization
Production API access is available to authorized corporate users and registered integration clients only.

Supported Scenarios

  • equipment position and status reporting;
  • fuel activity and refill event synchronization;
  • shift and operational update transmission;
  • integration with ERP and internal reporting systems;
  • dispatch event logging and service-side processing.
API status: operational

Sample Request

Example payload used to submit a telemetry event into the synchronization pipeline:

POST /api/v1/sync HTTP/1.1
Host: forestapi.su
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"
}

Sample Response

When the event is accepted for processing, the service returns a confirmation response:

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

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

Authorization Errors

If the token is missing or invalid, the service returns an authorization response:

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"
}

Integration Requirements

  • all production traffic must be transmitted over HTTPS;
  • request bodies must use JSON format;
  • timestamps must be submitted in UTC;
  • equipment identifiers must be unique within the integration environment;
  • API access is provisioned after client registration and approval.