Skip to Content
ReferenceMobile OpenAPI

Mobile OpenAPI

The checked contract is copied from engage-backend/docs/openapi/sdk-v1.yaml and validated for drift when both repositories are present.

Download mobile-edge-v1.yaml.

Intended audience

Use the contract to:

  • audit mobile/backend compatibility;
  • implement or review an official Engage SDK;
  • generate test fixtures or conformance clients;
  • inspect request/response schemas and security boundaries.

Application developers should use Android, iOS, or Flutter. A raw HTTP client would need to recreate secure credential storage, recovery, batching, retry, generation safety, content caching, inbox convergence, and privacy revocation.

Contract drift check

In a sibling checkout:

npm run check:openapi

After an intentional backend change:

npm run sync:openapi
npm run check

Set ENGAGE_BACKEND_DIR when the backend is not at ../engage-backend.

Base path and authentication

The contract uses /v1. Bootstrap uses X-Engage-App-Key; subsequent SDK requests use an opaque installation bearer credential. Server binding transitions use a secret environment access key and Idempotency-Key.

See Mobile edge API for a guided overview.

Implementation coverage