API Documentation

Build with OnFlyGo API

Integrate OBC services directly into your systems. RESTful API with real-time tracking and automated documentation.

API Capabilities

Booking API

Create and manage OBC shipments programmatically

Tracking API

Real-time GPS tracking and status updates

Documents API

Auto-generate IATA compliant documentation

Couriers API

Access verified courier network and availability

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header.

curl -X GET "https://api.onflygo.com/v1/shipments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

Base URL: https://api.onflygo.com

POST/v1/shipments

Create a new OBC shipment

{
  "origin": {
    "airport": "FRA",
    "address": "Frankfurt, Germany"
  },
  "destination": {
    "airport": "JFK",
    "address": "New York, USA"
  },
  "package": {
    "weight_kg": 5,
    "dimensions": "30x20x15",
    "description": "AOG spare parts"
  },
  "urgency": "same_day",
  "pickup_time": "2025-01-15T10:00:00Z"
}

GET/v1/shipments/{id}/tracking

Get real-time tracking for a shipment

{
  "shipment_id": "SHP-2025-001234",
  "status": "in_transit",
  "current_location": {
    "lat": 50.0379,
    "lng": 8.5622,
    "airport": "FRA",
    "updated_at": "2025-01-15T14:30:00Z"
  },
  "eta": "2025-01-15T22:00:00Z",
  "events": [
    {
      "type": "picked_up",
      "timestamp": "2025-01-15T10:15:00Z",
      "location": "Frankfurt, Germany"
    },
    {
      "type": "security_cleared",
      "timestamp": "2025-01-15T12:00:00Z",
      "location": "FRA Airport"
    }
  ]
}

GET/v1/couriers/available

Find available couriers for a route

{
  "couriers": [
    {
      "id": "COU-001",
      "name": "John D.",
      "rating": 4.9,
      "completed_trips": 234,
      "available_from": "2025-01-15T08:00:00Z",
      "airports": ["FRA", "MUC", "JFK", "LAX"]
    }
  ],
  "total": 12
}

POST/v1/documents/generate

Generate shipping documents

{
  "shipment_id": "SHP-2025-001234",
  "documents": [
    {
      "type": "awb",
      "url": "https://api.onflygo.com/docs/awb-001234.pdf"
    },
    {
      "type": "customs_declaration",
      "url": "https://api.onflygo.com/docs/customs-001234.pdf"
    },
    {
      "type": "chain_of_custody",
      "url": "https://api.onflygo.com/docs/coc-001234.pdf"
    }
  ]
}

Webhooks

Receive real-time notifications when shipment status changes.

shipment.created

shipment.courier_assigned

shipment.picked_up

shipment.in_transit

shipment.customs_cleared

shipment.delivered

Rate Limits

API requests are rate limited based on your plan.

Starter100 requests/min

Professional1,000 requests/min

EnterpriseUnlimited

SDKs & Libraries

Official client libraries for popular languages.

Node.jsComing soon

PythonComing soon

PHPComing soon

GoComing soon

JavaComing soon