Instructions

Follow these instructions to link your Airbly aircraft monitor to your Coflyt account. This process can be performed using your web browser and requires that you login to both your Airbly account and your Coflyt account. This process should take about 5 minutes to complete.

1. Login to your Airbly account at https://airbly.com/app
    
2. Go into the group setting page by clicking on the button from the menu bar.
    
3. Scroll down to the 'Integrations and API' section. If the Read-only key is blank, you will need to generate an API key. If there is a 30 character alpha-numeric string, skip to step #7 below.
   
    
4. Click on the button in the 'Integrations and API' section. This will bring up the integration editor.
    
5. Click on the button to generate a new Read-only key.
    
6. Click on the button to save your new Read-only key.
    
7. Copy the Read-only key value to your clipboard by highlighting it, right clicking, and selecting 'Copy'.
    
8. Login to your Coflyt account at https://app.coflyt.com/
    
9. Go into the settings page by clicking on the button from the menu bar.
    
10. Select the tab on the settings page.
     
11. Scroll down to the Airbly integration section.
    
     
12. Select the button in the Airbly integration section.
     
13. Paste the 'Read-only key' you copied from step 7 from Airbly into the field labeled 'Group key' on the Coflyt integration page.
    
     
14. Click button at the bottom of the 'Connect with Airbly' section. This will create the connection to Airbly.
     
15. In the Coflyt appliction, you should now see that you are linked to Airbly.
    
     
16. In the Airbly application, you should now see that you are linked to Coflyt.
    
     
17. Anytime a flight is created or updated in the Airbly system for your aircraft, that same flight information will be copied to the matching aircraft in the Coflyt system. Ensure that the tail number in Airbly matches the tail number in Coflyt identically for any aircraft you wish to link together.
     

Instructions

Follow these instructions to link your Airbly aircraft monitor to your PLANELOGIX account. This process can be performed using your web browser and requires that you login to both your Airbly account and your PLANELOGIX account. This process should take about 5 minutes to complete.

1. Login to your Airbly account at https://airbly.com/app
    
2. Go into the group setting page by clicking on the button from the menu bar.
    
3. Scroll down to the 'Integrations and API' section. If the Read-only key is blank, you will need to generate an API key. If there is a 30 character alpha-numeric string, skip to step #7 below.
   
    
4. Click on the button in the 'Integrations and API' section. This will bring up the integration editor.
    
5. Click on the button to generate a new Read-only key.
    
6. Click on the button to save your new Read-only key.
    
7. Copy the Read-only key value to your clipboard by highlighting it, right clicking, and selecting 'Copy'.
    
8. Login to your PLANELOGIX account at https://planelogix.com/ and click on the button from the menu bar.
    
9. Go into your aircraft settings page by clicking Settings on the left hand menu and then Aircraft.
   
    
10. Pick the aircraft from your aircraft list which you want to link to Airbly and click on the button.
     
11. Scroll down to the Third Party integration section.
    
     
12. Paste the 'Read-only key' you copied from step 7 from Airbly into the field labeled 'Read-only key' on the PLANELOGIX aircraft settings page.
    
     
13. Click button below the 'Read-only key' field. This will create the connection to Airbly.
     
14. In the PLANELOGIX app, you will see a confirmation that the connection was made.
    
     
15. In the Airbly application, you should now see that you are linked to PLANELOGIX.
    
     
16. Anytime a flight is created or updated in the Airbly system for your aircraft, that same flight information (including engine cycles) will be copied to the matching aircraft in the PLANELOGIX system. If you edit your flights in Airbly, those edits will appear in PLANELOGIX too. Ensure that the tail number in Airbly matches the tail number in PLANELOGIX identically for any aircraft you wish to link together.
     

Instructions

Linking QuantumMX to Airbly:

1. Login to your Airbly account at https://airbly.com/app
    
2. Go into the group setting page by clicking on the button from the menu bar.
    
3. Scroll down to the 'Integrations and API' section. If the Read-only key is blank, you will need to generate an API key. If there is a 30 character alpha-numeric string, skip to step #7 below.
   
    
4. Click on the button in the 'Integrations and API' section. This will bring up the integration editor.
    
5. Click on the button to generate a new Read-only key.
    
6. Click on the button to save your new Read-only key.
    
7. Copy the Read-only key value to your clipboard by highlighting it, right clicking, and selecting 'Copy'.
    
8. Follow the QuantumMX instructions at https://www.flyonlinetools.help/articles/airbly-integration.
    
9. In the Airbly application, you should now see that you are linked to QuantumMX.
   
    
10. Anytime a flight is created or updated in the Airbly system for your aircraft, that same flight information will be copied to the matching aircraft in the QuantumMX system. If you edit your flights in Airbly, those edits will appear in QuantumMX too.
     

assetList API command

The assetList API command is used to return a list of assets, their usage logs and position reports. The response data can be filtered by passing arguments via GET or POST. Here is an example of the assetList API call: https://airbly.com/api/v3/assetList?groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC

Sample data

We have setup a sample group ("API-Test") which you can use to see how the API commands function. This group contains two aircraft, each with a few log entries. The keys and UUIDs for the test data are:

   Group uuid: 00000001-4444-1100-0000-000000000001
   Group key: 9C4NSsnLig3zlgzPHqLkXwHPtKv7OC
   N44API uuid: 00000001-4444-2000-8846-001471040618
   N88API uuid: 00001000-4444-2000-5574-001522329325

Data types

The API will process and respond using the following data types:

Group authentication key

All requests require a valid group API key to be sent as part of the request (groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC for example). This key can be generated in the Airbly web application on the group page by a user with Administrator access to the group. Everytime a new key is generated, the old one is invalidated. There can only be one valid API key per group at a time.

Request

API requests at made to the following URL, with these minimum arguments:
https://airbly.com/api/v3/assetList?groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC

You should replace assetList with the API command you would like to execute.
You should replace 9C4NSsnLig3zlgzPHqLkXwHPtKv7OC with your group's key

Arguments may be sent as either GET or POST values. For example, this URL will request just the N44API aircraft:
https://airbly.com/api/v3/assetList?groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC&asset_uuids=00000001-4444-2000-8846-001471040618

Response defaults

The API endpoint will respond with a JSON object. The complete contents of this object will vary based on the command executed, but there are several fields which are included in every request. Those are:

"cmd": "assetList",
"cmd_exec_time_ms": 472,
"error": "",
"auth_group_success": true,
"auth_group_id": "00000001-4444-1100-1940-001461853639",
"server_timestamp": 1579287172000,
"server_available": true,
"server_message_timestamp": 0,
"server_message": "",
"assetList": { }
                            

Arguments

The following arguments maybe used with the assetList API call. Logs are only returned for matched assets. Points are only returned for matched logs with matched assets.

Example

To retrieve the 5 most recent flights with the start and end points from all assets in our sample group:
https://airbly.com/api/v3/assetList?groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC&log_types=flight&log_limit_per_asset=5&point_types=first,last

Response details

The response will be an array of asset objects and relevant sub-objects. Below you will find a description of each of these object types and fields.

asset object

{
    "uuid": "00004000-4444-2000-6311-001551812065",
    "created_at": 1551812065000,
    "updated_at": 1575643428000,
    "asset_type": "aircraft",
    "parrent_uuid": "00000000-0000-0000-0000-000000000000",
    "children_uuid": [],
    "ident": "D10-7978",
    "make": "C100",
    "model": "Archives",
    "year": 2019,
    "serial_number": "",
    "description": "Test",
    "operational_status": "stopped",
    "attention_status": "none",
    "maintenance_status": "none",
    "usage": { usage object }
    "device": { device object }
    "logs": [ log objects ]
}
                        

log object

{
    "uuid": "00004000-4444-2000-6311-001551812065",
    "created_at": 1551812065000,
    "updated_at": 1575643428000,
    "log_type": "flight",
    "status": "closed",
    "happened_at": 1579899600000,
    "attention_required": true,
    "remarks": "",
    "route": { route object },
    "personel": [ personel objects ],
    "device": { device object },
    "sync": { sync object },
    "usage": { usage object },
    "events": { events object },
    "points": [ points objects ],
    "custom": [ custom data ]    
}
                        

point object

{
    "uuid": "03b74444-0000-4200-016f-85a589b600f9",
    "happened_at": 1578057089000,
    "synced_at": 0,
    "point_type": "start",
    "latitude": 46.2797,
    "longitude": -63.1273,
    "altitude": 200,
    "sensors": {},
    "events": [ "takeoff" ]
}
                        

usage object

{
    "type": "incremental",
    "engine_seconds": 3600,
    "air_seconds": 2400,
    "tach_seconds": 3000,
    "landings": 17,
    "cycles": 0,
    "movements": 0,
    "engine_start_at": 1578055517000,
    "engine_stop_at": 1578057089000,
    "block_start_at": 1578055644000,
    "block_stop_at": 1578056907000,
    "air_first_takeoff": 1578055644000,
    "air_last_landing": 1578056907000,
    "fuel_ml": 0,
    "oil_ml" : 0
}
                        

device object

{
"uuid": "00000001-4444-3000-7877-001460749906",
"serial_number": "P100-2327557",
"firmware_version": 58,
"battery": "low",
"last_sync_at": 1531747012000,
}
                        

route object

{
    "departure_ident": "CYYG",
    "arrival_ident": "CYSU"
}
                        

personel object

{
    "uuid": "00000001-4444-1000-3295-001453387958",
    "fullname": "Chris VanHorn",
    "type": "mechanic"
}
                        

sync object

{
    "type": "log",
    "happened_at": 1578057089000,
    "by_device_serial_number": "H100-1000002"
}
                        

sensor object

    {
        "g_force": 1,
        "pitch_angle": 0,
        "roll_angle": 0,
        "vertical_speed": 0,
        "ground_speed": 0,
        "heading": 0,
        "bearing": 0,
        "temperature": 0,
        "gps_satellite_count": 16,
        "vibration": 10000
    }
                        

Webhooks

Webhooks allow our system to automatically push asset, log and point data to your system when they change. For example, when one of our monitoring devices closes out a flight log, our system can automatically send that log to your system. The webhook will be sent within 60 seconds of an update to an asset, log or point. If multiple objects have changed since the last post, multiple entries will be included in the single webhook post.

Configuration

To enable webhooks, you will need to set the endpoint where you would like the data to be sent. This should be in the form of a web URL. This can be set on the group settings page in our application. If you would like to disable the webhook, simply erase the web URL can click save.

POST Data format

The webhook will post a JSON object to your endpoint. That object is the equivalent to calling the assetList API command with the following arguments:

asset_types=all
asset_updated_after=timestamp of the oldest entry in the last webhook post
log_types=all
log_updated_after=timestamp of the oldest entry in the last webhook post
log_limit_per_asset=999
point_types=first,last
                

Expected response

{
    "cmd": "webhookAssetList",
    "group_uuid": "00000000-0000-0000-0000-000000000000",
    "server_timestamp": 1580498821000,
    "asset_count": 4,
    "error": ""
}
                        

Sample code

This sample code is written in PHP and demonstrates how your endpoint should reply to a webhook post.

<?php

// Initialize our response
$response = new stdClass();
$response->cmd = 'unknown';
$response->group_uuid = '00000000-0000-0000-0000-000000000000';
$response->server_timestamp = time();
$response->asset_count = 0;
$response->error = '';

// Process the data
try {

    // Collect the post data
    $post_raw = file_get_contents("php://input");
    if (!$post_raw) throw new Exception('No data was received');

    // Decode the JSON into a PHP object
    $post_decoded = json_decode($post_raw);
    if (!$post_decoded) throw new Exception('Invalid json data received');

    // Collect the group UUID
    if (!isset($post_decoded->group->uuid)) throw new Exception('No group uuid was received');
    $response->group_uuid = $post_decoded->group->uuid;

    // Collect the command
    if (!isset($post_decoded->cmd)) throw new Exception('No cmd was received');
    $response->cmd = $post_decoded->cmd;

    // Verify the command
    if ($response->cmd != 'webhookAssetList') throw new Exception('Invalid command was received');

    // Did we receive any assets
    if (!isset($post_decoded->assets) OR !is_array($post_decoded->assets)) throw new Exception('No assets were received');

    // Step through the aircraft
    foreach ($post_decoded->assets AS $asset {
        $response->asset_count++;

        // -- YOUR CUSTOM CODE HERE TO PROCESS THE ASSET --

    }

    // Catch our errors
    } catch (Exception $e) {
        $response->error = $e->getMessage();
        http_response_code(400);
    }

    // Return a JSON object response
    $response_json = json_encode($response);
    header('Content-type: application/json');
    echo $response_json;
?>