@volant-autonomy/via-sdk v1.3165.1

Volant Via SDK

@volant-autonomy/via-sdk is an auto-generated type-safe wrapper for the Via API with automatic authentication handling. Usable in TypeScript or JavaScript.

Note: To use this SDK you need access to the Via API. Please contact us at via@volantautonomy.com to obtain access.

Installation

Run npm install --save @volant-autonomy/via-sdk to add the SDK as a dependency.

Basic usage

import { createSDK } from '@volant-autonomy/via-sdk'

const SDK = createSDK({
  username: "username",
  password: "password"
})

const {error, data} = await SDK.direct.getAllAircraft()

Further information

SDK Layout

The SDK is split into three parts:

• Direct: Gives you direct access to every single API endpoint, returning the raw data
• Composite: Convenient wrappers around multi-endpoint operations
• Schemas: Every schema from the api as a TypeScript type

Auth

If you provide a username and password, the SDK will automatically check for expiry and refresh the authentication token whenever you make a request.

Request data format

In the API, data may be passed in through the body, the URL, the query, the header, etc. The SDK simplifies this, and just always takes data in as function arguments.

For example, GET /flightplans/ takes in a filter from a query parameter. The SDK does this through function arguments, ie: SDK.direct.getAllFlightplans(['Accepted']) would filter for only accepted flightplans.

Another example, GET /flightplans/{flightplan_id} takes in a flightplan ID through the path. The SDK does this through function arguments, ie: SDK.direct.getFlightplan('aaaaa-bbbbb-ccccc')

Feature list

As well as offering methods for all endpoints within the API, you have access to a variety of features in this API Wrapper that help make some common workflows more convenient. These features are as follows:

Response data format

Direct functions return an object with a data field and an error field. Only exactly one of these is defined, the other is undefined.

The data returned is also not identical to the API, as any "links" are skipped over, to make the data easier to use.

For example, if the API would've returned:

{
  link:"/url",
  data: [
    {data: 1, link: "/url"}, 
    {data: 2, link: "/url"}
  ]
}

The SDK will instead just return [1,2].

Keeping this in mind, the API documentation is a great place to look for more information