Yamasee Skypath - Turbulence and Weather Management in Commercial Aviation - API documentation (1.1.4)

Download OpenAPI specification:Download

Skypath by Yamasee Inc is a unique service that can help airline pilots avoid clear air turbulence. This is the API documentation for interacting with the Skypath server for application developers. It describes the Skypath turbulence avoidance server Rest API in OpenAPI 3.0 specification. You will need a partner API_KEY to be able to login to the system and get authentication tokens valid for the different REST operations

Authentication

bearerAuth

JWT non expired token recived in response to a successful login request

Security Scheme Type API Key
Header parameter name: x-access-token

apiKey

API key to authorize requests. If you don't have a Skypath API key, contact Yamasee support

Security Scheme Type API Key
Header parameter name: api-key

registration

These routes are public and return user information for new users

set_user_profile

Client can set user profile like password and other future properties for non init users, if user is not a new user the operation will fail with not authorized code.

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Request Body schema: application/json

User profile params

password
required
string

new chosen password

token
required
string

the token received from the OTP validation request

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

general

These routes are public and return general information about the system like supported aircraft types and server / client recommended versions

contact

Used to send user contact us / feedback form

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Request Body schema: application/json

The user contact request

message
string

text message the user wants to send

email
string

the users email

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "email": "string"
}

aircraft_types

Returns a list of system supported aircraft types

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

hello

Gets basic information about Skypath server version and minimal client version needed, if the app version is lower than the minimal allowed app version the client needs to block logging-in and suggest the user to upgrade the Skypath app version on the device.

Responses

Response samples

Content type
application/json
{
  • "ver": "1.2.4",
  • "current_app_version": "4.0.0",
  • "minimal_compatible_app_version": "3.5.1"
}

auth

These routes allow authentication, Login with API key, Refresh JWT tokens

forgot_password

Used to request a password reset link for a user

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Request Body schema: application/json

User id param

user_id
required
string

user name or email or requesting user

Responses

Request samples

Content type
application/json
{
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

login

Login to the server and get a authorization JWT token, this allows user to exchange their username / email and password for a JWT token which can be user in further requests. All requests that need this token are marked as such in this documentation

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Request Body schema: application/json

Login params

user_id
required
string

user id or email of user that logs in

password
required
string

clear text password

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{}

otp_request

Request a new OTP code for uninitialized user

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Request Body schema: application/json

OTP request params

token
required
string

the token received from the login request

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "otp_sent": true
}

otp_validate

Validate OTP code

header Parameters
X-Skypath-SDK
string

Version of sdk

X-Skypath-App
string

Version of application

Request Body schema: application/json

OTP validation params

otp
required
string

the OTP code

token
required
string

the token received from the login request

Responses

Request samples