Overview

IoT OS integration API 1.0.0

The scoped API that external applications use with an application token. Generated from the platform’s API contract at the release the hosted service runs.

Information

• OpenAPI version: 3.1.0

Operations

GET

/integration/v1/organizations/{organization}/alerts

GET

/integration/v1/organizations/{organization}/alerts/{uuid}

GET

/integration/v1/organizations/{organization}/devices

GET

/integration/v1/organizations/{organization}/devices/{uuid}

GET

/integration/v1/organizations/{organization}/devices/{uuid}/location-bindings

GET

/integration/v1/organizations/{organization}/devices/{uuid}/locations/{event}

GET

/integration/v1/organizations/{organization}/devices/{uuid}/telemetry/history

GET

/integration/v1/organizations/{organization}/devices/{uuid}/telemetry/latest

GET

/integration/v1/organizations/{organization}/devices/{uuid}/telemetry/records

GET

/integration/v1/organizations/{organization}/events

GET

/integration/v1/organizations/{organization}/events/checkpoint

GET

/integration/v1/organizations/{organization}/geofences

POST

/integration/v1/organizations/{organization}/geofences

GET

/integration/v1/organizations/{organization}/geofences/{uuid}

PUT

/integration/v1/organizations/{organization}/geofences/{uuid}

GET

/integration/v1/organizations/{organization}/geofences/{uuid}/activations/{batch}

POST

/integration/v1/organizations/{organization}/geofences/{uuid}/activations/{batch}/items/{item}/retry

POST

/integration/v1/organizations/{organization}/location-map/query

POST

Signed delivery of one integration event WEBHOOK

Authentication

applicationToken

Application token for the integration API (/integration/v1) only, sent as Authorization: Bearer <token>. An organization administrator issues it for one application; each application has one active token, valid for 1 to 90 days, whose abilities are a subset of the application’s grants. Session cookies and personal user tokens are ignored on integration operations.

401 when the token is missing, invalid, expired or revoked; 403 when an ability the operation needs is not granted on both the application and the token; 404 for another organization or a resource not granted to the application.

Security scheme type: http