Auth - vAMSYS Protocol API Reference

This API is not for public consumption.

Get User Token

POST/pegasus/v1/auth

Required attributes

Name
application_key
Type
string
Description
Name
email
Type
string
Description
Name
password
Type
string
Description

Invalid Application key

{
    "status": 401,
    "message": "INVALID_APPLICATION"
}

User is Banned or no pilot accounts found

{
    "status": 401,
    "message": "NO_ACCOUNTS"
}

User is Unverified

{
    "status": 401,
    "message": "UNVERIFIED_USER"
}

User has no access to Beta

{
    "status": 401,
    "message": "NO_BETA_ACCESS"
}

Invalid Credentials

{
    "status": 401,
    "message": "INVALID_CREDENTIALS"
}

Success Response

{
    "status": 200,
    "message": "OK",
    "token": "FFKjL7F8bRJQCcJ2FHiH796Cvrc3wm1g69UufGpJuTMK35GQNyvFfhJKvmAo"
}

Get User Details

POST/pegasus/v1/user

Required attributes

Name
application_key
Type
string
Description
Name
api_key
Type
string
Description

Header attributes

Name
X-Pegasus-Version
Type
string
Description

Invalid Application key

{
    "status": 401,
    "message": "INVALID_APPLICATION"
}

Invalid User API Token

{
    "status": 401,
    "message": "INVALID_TOKEN"
}

Request from outdated Pegasus Version

{
    "status": 401,
    "message": "OUTDATED_VERSION"
}

User is Banned

{
    "status": 401,
    "message": "NO_ACCOUNTS"
}

Success Response

{
    "status": 200,
    "message": "OK",
    "user": {
        "id": 1,
        "first_name": "vAMSYS",
        "last_name": "Robot",
        "email": "[email protected]",
        "simbrief_username": "vamsysio",
        "airlines": [
            {
                "id": 2999,
                "name": "Air Caraibes Virtuel",
                "username": "FWI-Lukas",
                "logo_url_light": "https:\/\/cdn.vamsys.xyz\/logos\/01JR6BND9E0RRYBPS55MZQRF5J.png",
                "logo_url_dark": "https:\/\/cdn.vamsys.xyz\/logos\/01JR6BNDA9DXA51M60W03F0S4D.png",
                "simbrief_username": "vamsysio",
                "accent_color": "#fff",
                "booking": {
                    "callsign": "FWI511",
                    "flight_number": "TX511",
                    "aircraft_type": "A35K",
                    "departure_airport_icao": "TFFF",
                    "departure_airport_iata": "FDF",
                    "departure_airport_name": "Int'l Martinique Aim\u00e9 C\u00e9saire",
                    "arrival_airport_icao": "LFPO",
                    "arrival_airport_iata": "ORY",
                    "arrival_airport_name": "Paris-Orly"
                    },
                "prefix": "FWI"
            }
        ],
        "airlinesNoBooking": [
            {
                "id": 2999,
                "name": "Air Caraibes Virtuel",
                "username": "FWI-Lukas",
                "logo_url_light": "https:\/\/cdn.vamsys.xyz\/logos\/01JR6BND9E0RRYBPS55MZQRF5J.png",
                "logo_url_dark": "https:\/\/cdn.vamsys.xyz\/logos\/01JR6BNDA9DXA51M60W03F0S4D.png",
                "simbrief_username": "vamsysio",
                "accent_color": "#fff",
                "booking": {
                    "callsign": "FWI511",
                    "flight_number": "TX511",
                    "aircraft_type": "A35K",
                    "departure_airport_icao": "TFFF",
                    "departure_airport_iata": "FDF",
                    "departure_airport_name": "Int'l Martinique Aim\u00e9 C\u00e9saire",
                    "arrival_airport_icao": "LFPO",
                    "arrival_airport_iata": "ORY",
                    "arrival_airport_name": "Paris-Orly"
                    },
                "prefix": "FWI"
            }
        ],
        "airlinesBooking": [
            {
                "id": 2999,
                "name": "Air Caraibes Virtuel",
                "username": "FWI-Lukas",
                "logo_url_light": "https:\/\/cdn.vamsys.xyz\/logos\/01JR6BND9E0RRYBPS55MZQRF5J.png",
                "logo_url_dark": "https:\/\/cdn.vamsys.xyz\/logos\/01JR6BNDA9DXA51M60W03F0S4D.png",
                "simbrief_username": "vamsysio",
                "accent_color": "#fff",
                "booking": {
                    "callsign": "FWI511",
                    "flight_number": "TX511",
                    "aircraft_type": "A35K",
                    "departure_airport_icao": "TFFF",
                    "departure_airport_iata": "FDF",
                    "departure_airport_name": "Int'l Martinique Aim\u00e9 C\u00e9saire",
                    "arrival_airport_icao": "LFPO",
                    "arrival_airport_iata": "ORY",
                    "arrival_airport_name": "Paris-Orly"
                },
                "prefix": "FWI"
            }
        ],
        "is_pegasus_administrator": true | false,
        "pegasus_state": null | "devtools_user" | "admin",
    }
}