End-to-end integration journey

A production integration is more than a successful API request. It connects identity, entitlement, emergency response, asynchronous updates, and operational support into one reliable journey.

This diagram depicts the customer-scoped path. A pure Fixed-Location integration (an alarm-monitoring platform, for example) skips customer creation and subscription entitlement entirely — see the branches in steps 2 and 3.

1. Authenticate your backend

Exchange your clientId and clientSecret for a server bearer token. Keep both credentials and tokens out of browsers, mobile apps, URLs, and logs.

Start with Authentication and API conventions.

2. Register what’s protected

• A moving person, or a customer-linked property (People Protect, or the smart-home hybrid Property Protect pattern): create a customer and retain both AURA’s customerId and your own externalReferenceId. See Customers.
• A known site with no linked customer (a monitoring platform or alarm receiving centre): create or import the Fixed Location using your own externalReferenceId. No AURA customer is created for this pattern — the Fixed Location callout resolves directly against the site, and its response carries customerId: null. See Fixed Locations and Monitoring Platforms.

3. Establish entitlement

Entitlement depends on which path you took in step 2:

• Customer-scoped path: activate a subscription before exposing live panic functionality. Subscription type IDs are environment-specific, so resolve them in staging and production rather than copying an ID between environments. Use Subscriptions for direct API management or a supported hosted flow.
• Fixed-Location-only path: there is no per-callout subscription check — creating a Fixed Location callout has no subscription precondition. Entitlement is commercial/contractual, established when Fixed Locations are provisioned for your customer source, not per API call.

4. Create the right callout

• For a moving person, create a customer callout with current coordinates.
• For a known site, create a Fixed Location callout, preferably using your external reference.
• For a supported device, link it to the customer and send device events using the template agreed during onboarding.

See Callout lifecycle.

5. Track the response

Use webhooks for server-to-server lifecycle updates. Poll only where the customer experience needs current callout state, and stop location updates when the callout closes or the API returns its closed-callout status.

The hosted callout-tracking flow can provide a customer-facing experience without exposing your server token.

6. Cancel, close, and learn

Cancel a callout when help is no longer required. AURA’s control centre owns final operational closure. After closure, collect a rating where it fits your product and use operational reporting to improve the journey.

Build in this order

Implement the happy path first, then verify invalid credentials, missing subscriptions, duplicate/active callouts, cancellation, closed callouts, webhook duplication, and transient failures. The integration testing playbook turns these into concrete staging scenarios.