Skip to main content
Documentação da API

Construa com a API da OnFlyGo

Integre serviços OBC diretamente aos seus sistemas. API RESTful com rastreamento em tempo real e documentação automatizada.

Recursos da API

API de Reservas

Crie e gerencie envios OBC de forma programática

API de Rastreamento

Rastreamento GPS em tempo real e atualizações de status

API de Documentos

Gere automaticamente documentação em conformidade com a IATA

API de Couriers

Acesso à rede verificada de couriers e disponibilidade

Autenticação

Todas as requisições à API exigem autenticação por chave de API. Inclua sua chave no cabeçalho Authorization.

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

Endpoints da API

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

POST/v1/shipments
Cria um novo envio OBC
{
  "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
Obtém rastreamento em tempo real de um envio
{
  "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
Encontra couriers disponíveis para uma rota
{
  "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
Gera documentos de envio
{
  "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

Receba notificações em tempo real quando o status do envio mudar.

shipment.created
shipment.courier_assigned
shipment.picked_up
shipment.in_transit
shipment.customs_cleared
shipment.delivered

Limites de uso

As requisições à API são limitadas conforme seu plano.

Starter100 requisições/min
Professional1.000 requisições/min
EnterpriseIlimitado

SDKs e bibliotecas

Bibliotecas-cliente oficiais para as principais linguagens.

Node.jsEm breve
PythonEm breve
PHPEm breve
GoEm breve
JavaEm breve

Pronto para integrar?

Entre em contato para obter suas credenciais de API e começar a desenvolver.