Magic Link
Generate and retrieve a public Magic Link for a Route Map
less than a minute
The API endpoint generates and returns a public Magic Link associated with a Route Map.
GET /ffw/startracking/routemap/{AWB}/magiclink?day=10 HTTP/1.1
Host: api.startracking.aero
Accept: application/json
Authorization: Bearer {{BEARER TOKEN}}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| AWB | string | Yes | Air Waybill number composed of exactly 11 digits. |
| day | integer | No | Number of days the Magic Link remains valid. Values greater than 10 are automatically set to 10. Values less than or equal to 0 disable any previously generated Link. |
Response
{
"Guid": "8d7c44c6-18b6-4b35-8b98-8b4f679418fb",
"WebSiteUrl": "https://routemap.example.com/12345678901/8d7c44c6-18b6-4b35-8b98-8b4f679418fb"
}
Returned Properties
| Property | Description |
|---|---|
| Guid | Unique identifier generated for the Link. |
| WebSiteUrl | Ready to use public URL. |
Behaviour
The endpoint:
- Verifies that the Magic Link feature is enabled.
- Validates the AWB format.
- Generates or retrieves the Magic Link.
- Populates the
WebSiteUrlproperty. - Returns the
MagicLinkobject.
Responses
| HTTP Code | Description |
|---|---|
| 200 | Magic Link successfully generated or retrieved. |
| 400 | Invalid request parameters. |
| 500 | Internal server error. |
Note
When no Route Map is found for the specified AWB, the API returns an empty JSON object (
{}).