Getting Started

This guide helps you integrate quickly with the Jitra Public API and avoid common setup issues.

Overview

The Public API provides read access to organization data such as objects, positions, geofences, routes, and sites.

Before You Start

Prepare the following:

  • A valid API key for your organization.
  • Network access to the API host and HTTPS port.
  • An HTTP client such as curl, Postman, or code-based HTTP libraries.

Base URL and Versioning

Use the public base URL:

https://api.jitra.app/public/v1

Append resource paths to that base URL.

Authentication

All endpoints require an API key.

You can authenticate with either header:

  • x-api-key: <api_key>
  • Authorization: Bearer <api_key>

If the key is missing, invalid, or expired, the API returns 401.

Recommended header examples:

x-api-key: <api_key>
Authorization: Bearer <api_key>

Rate Limits

Requests are rate-limited per organization.

SettingValue
Window10 seconds
Max requests10 requests per window

When the limit is exceeded, the API returns 429.

Request and Response Basics

Successful Response Wrapper

Successful responses use:

{
  "statusCode": 200,
  "result": {}
}

result can be an object or an array depending on the endpoint.

Error Response Wrapper

Error responses follow:

{
  "statusCode": 400,
  "errorCode": "PUBLIC.400_001",
  "message": "Validation error message",
  "timestamp": "2026-05-17T01:00:00.000Z"
}

Quickstart Workflow

Use this sequence to validate integration in minutes:

1) Verify API Key with Object List

This is the safest first call because it requires no path or query parameters.

curl --request GET \
  --url https://api.jitra.app/public/v1/objects \
  --header 'x-api-key: <api_key>'

2) Read One Object

Take one id from step 1:

curl --request GET \
  --url https://api.jitra.app/public/v1/objects/101 \
  --header 'x-api-key: <api_key>'

3) Read Latest Positions

Request multiple IDs in one call:

curl --request GET \
  --url 'https://api.jitra.app/public/v1/positions/latest?ids=101,102' \
  --header 'x-api-key: <api_key>'

Common HTTP Outcomes

HTTP StatusMeaningTypical Action
200Request succeededProcess result.
400Invalid request inputFix path/query values and retry.
401Authentication failedCheck API key value and header format.
404Resource not foundConfirm the requested object exists in your organization.
429Rate limit exceededRetry with backoff after waiting for the next window.

Integration Checklist

  • Store API keys in secure secrets storage, not in source code.
  • Use HTTPS for all environments.
  • Add retry/backoff handling for 429.
  • Log request IDs and response status for support and monitoring.
  • Parse datetime values as ISO 8601 UTC timestamps.

Notes

  • This API is read-oriented and designed for public integration access.
  • Field-level contracts are documented on each endpoint page.