connections

Server

Exchange a pairing code for a connection token. The AirTrack user generates a short-lived 6-digit code in the app and enters it into your client; your client redeems it here for a long-lived aapk_ bearer token carrying exactly the capabilities the user granted. This is the only unauthenticated endpoint. Redeeming a code draws no credits. Managing a connection afterwards — listing, renaming, revoking — is done by its owner in the AirTrack app, not through this API.

Redeem Pairing Code

POST

https://api.airawarelabs.com

/v1/connections/token

Redeem a pairing code for a connection token. Unauthenticated — the code is the proof of ownership. The raw token is returned exactly once.

Redeem Pairing Code › Request Body

Sent by a connecting client (unauthenticated) to redeem a code for a token. The 6-digit ``code`` is the proof of ownership — it was just typed in by the user from the app. ``name`` labels the connection (e.g. "Pom Pom").

RedeemPairingCodeSchema

code

string · minLength: 6 · maxLength: 6 · pattern: ^\d{6}$ · required

The 6-digit code the user generated in the app.

name

string · minLength: 1 · maxLength: 100 · required

A label to identify this connection.

Redeem Pairing Code › Responses

Successful Response

Returned once, at pairing — the raw token is never retrievable again.

ConnectionTokenResponseSchema

connection_id

string · uuid · required

name

string · required

scopes

string[] · required

The capabilities the user granted this connection.

token

string · required

The bearer token — shown once, store it securely.

route-planning quota

Redeem Pairing Code

POST

https://api.airawarelabs.com

/v1/connections/token

Redeem a pairing code for a connection token. Unauthenticated — the code is the proof of ownership. The raw token is returned exactly once.

Redeem Pairing Code › Request Body

RedeemPairingCodeSchema

code

string · minLength: 6 · maxLength: 6 · pattern: ^\d{6}$ · required

The 6-digit code the user generated in the app.

name

string · minLength: 1 · maxLength: 100 · required

A label to identify this connection.

Redeem Pairing Code › Responses

Successful Response

Returned once, at pairing — the raw token is never retrievable again.

ConnectionTokenResponseSchema

connection_id

string · uuid · required

name

string · required

scopes

string[] · required

The capabilities the user granted this connection.

token

string · required

The bearer token — shown once, store it securely.