Getting Started with Aviationstack

Introduction

Quick Start Guide

Step 1: Your API Access Key

To get started quickly, you need to fork the Aviationstack Postman Collection. Simply click the button below to fork it.

Step 2: Get your API Access Key

1. Go to the Aviationstack website and choose the right subscription plan for your particular project.
2. Get your personal API Access Key on the Dashboard to authenticate with the API. Keep it safe! You can reset it at any time in your Account Dashboard.

Step 3: Make your first API call

Aviationstack Postman collection contains all the endpoints supported by Aviationstack API.

1. Flights
2. Routes
3. Airports
4. Airlines
5. Airplanes
6. Aircraft Types
7. Taxes
8. Cities
9. Countries
10. Flights Schedules
11. Flights Future Schedules

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Test the SDK

To validate the functionality of this SDK, you can execute all tests located in the test directory. This SDK utilizes Jest as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

npm run test

Or you can also run tests with coverage report:

npm run test:coverage

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | customQueryAuthenticationCredentials | CustomQueryAuthenticationCredentials | The credential object for customQueryAuthentication |

The API client can be initialized as follows:

import { Client, Environment } from 'aviation-stack-sdk';

const client = new Client({
  customQueryAuthenticationCredentials: {
    'access_key': 'access_key'
  },
  timeout: 0,
  environment: Environment.Production,
});

Authorization

This API uses the following authentication schemes.

• apiKey (Custom Query Parameter)

List of APIs

• Aircraft Types
• Flight Schedules
• Flight Future Schedules
• Flights
• Routes
• Airports
• Airlines
• Airplanes
• Taxes
• Cities
• Countries

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError