OpenFlight API Documentation

Welcome to the OpenFlight API. This service provides internal developers and partners with access to flight data, pricing engines, reservation management, and notification services for Signature Aviation and NetJets integrations.

Authentication

Most operations in this API require authentication.

• Method: OAuth 2.0 Bearer Token

• Header: Authorization: Bearer <your_token>

1. Airports API

Retrieve flight activity for specific airports.

Get Airport Flights (Trimmed)

Returns flights to and from a given airport, with optional date range and registration filters.

• Method: GET

• Endpoint: /airport/flightsV2/{icao}

Response Example (200 OK)

JSON

[
   {
     "flightType": "arrival",
     "icao": "KJFK",
     "iata": "JFK",
     "callsign": "DAL123",
     "regn": "N12345",
     "origin": "KLAX",
     "destination": "KJFK",
     "scheduled": "2025-08-01T04:03:21Z",
     "status": "landed"
   }
 ]

2. Notification API

Services for sending transactional communications.

Submit Email

Triggers an email via the internal SendGrid integration.

• Method: POST

• Endpoint: /notification/api/v1/email

Headers

• Content-Type: application/json

• Authorization: Bearer {token}

Request Body Schema

The request requires a clientId, notificationId, and a list of messages containing sender/recipient data and SendGrid template IDs.

Request Example

JSON

{
   "clientId": "ServiceApp_01",
   "notificationId": "guid-1234-5678",
   "timestamp": "2025-01-01T12:00:00Z",
   "priority": "normal",
   "messages": [
     {
       "messageId": "msg-001",
       "sender": { "email": "noreply@signatureaviation.com", "name": "Signature Support" },
       "recipients": [
         { "email": "partner@example.com", "name": "Partner User", "type": "to" }
       ],
       "template": {
         "name": "Reservation_Confirmation",
         "parameters": { "reservationId": "12345" }
       }
     }
   ]
 }

3. Pricing API

Retrieve retail and customer-specific pricing for fuel and services.

Fuel Pricing

• Get Customer Fuel Price: POST /pricing/api/v1/customer-fuel

  • Description: Retrieves specific pricing based on customerAccount and tailNumber.

• Get Retail Fuel Price: POST /pricing/api/v1/retail-fuel

  • Description: Retrieves general retail pricing for a base.

Service Pricing

• Get Customer Service Price: POST /pricing/api/v1/customer-service

  • Description: Retrieves service fees (handling, etc.) specific to a customer account.

• Get Retail Service Price: POST /pricing/api/v1/retail-service

  • Description: Retrieves standard service fees for a base.

Common Request Object (Fuel Example)

JSON

{
   "baseCode": "BOS",
   "baseTimeZone": "EST",
   "customerAccount": "123456",
   "tailNumber": "N123AB",
   "productCodes": ["JetA", "100LL"],
   "priceDate": "2025-06-01T10:00:00Z"
 }

4. Reservations API

This is the core domain for managing trips, reservations, and handling third-party integrations (FlightBridge, NetJets).

Core Operations

Submit Reservation

Submits a SIGnet reservation detail record.

• Method: POST

• Endpoint: /openflight/api/v1/reservation

Submit Trip

Submits a full trip containing multiple legs and service requests.

• Method: POST

• Endpoint: /openflight/api/v1/trip

Update Trip

Updates details of an existing trip.

• Method: PUT

• Endpoint: /openflight/v1/trip

Partner Integrations & Webhooks

NetJets Integration

• Submit Trip Info: POST /reservations/api/v1/netjets

  • Accepts complex trip structures including Legs, Travelers, and catering/rental orders.

• Send Notification: POST /reservations/api/v1/notifications/netjets

  • Push notification webhook for status updates (Success/Escalated/Fail).

FlightBridge Integration

• Client Notifications: POST /reservations/api/v1/flightbridge

  • Webhook for general FlightBridge reservation updates.

• NetJets Client Notifications: POST /reservations/api/v1/flightbridge/netjets

  • Webhook specific to NetJets environment updates.

Exception Handling

• Submit Exception: POST /reservations/api/v1/exception

  • Used to log errors or exceptions at the reservation or product level (e.g., catering unavailable).

Reservation Request Example (Simplified)

JSON

{
   "Baseid": "P61",
   "TailNumber": "N100",
   "DepartureDetails": {
     "EstimatedDepartureTimeUTC": "2025-06-13T00:00:00Z",
     "DepDestination": "JFK"
   },
   "Products": [
     {
       "ProductName": "Handling Charge",
       "Quantity": 1,
       "Unit": "Each",
       "ServiceDateUTC": "2025-02-09T15:22:00Z"
     }
   ],
   "ArrivalDetails": {
     "Arrpax": 3,
     "EstimatedArrivalTimeUTC": "2025-06-13T00:00:00Z",
     "ArrOrigin": "HTH"
   }
 }

5. Safety Data API

• Method: POST

• Endpoint: /safetydata/api/v1/submit

• Description: Endpoint for submitting operational safety reports and data. Requires standard authentication headers.