Environments
The Awell Orchestration API environments and regions, the GraphQL endpoint for each, and how an API key maps to one.
Awell runs the Orchestration API in more than one environment and region. Use Sandbox to build and test, and a production environment for live care. Send each request to the endpoint for the environment and region your data lives in.
Environments
There are two: Sandbox and Production. Sandbox is for exploring, testing and building your integration. Production runs live care and is available once your implementation goes live.
Production is deployed in three regions — EU, UK and US — and your data lives in exactly one of them. Sandbox is a single environment.
API endpoints
Each environment and region has its own GraphQL endpoint. Send every request to the one your data lives in.
| Environment | Endpoint |
|---|---|
| Sandbox | https://api.sandbox.awellhealth.com/orchestration/m2m/graphql |
| Production — EU | https://api.awellhealth.com/orchestration/m2m/graphql |
| Production — US | https://api.us.awellhealth.com/orchestration/m2m/graphql |
| Production — UK | https://api.uk.awellhealth.com/orchestration/m2m/graphql |
Where to get a key
API keys are created in the CareOps portal, which is a separate address per environment:
| Environment | CareOps portal |
|---|---|
| Sandbox | https://careops.sandbox.awellhealth.com/ |
| Production — EU | https://careops.awellhealth.com/ |
| Production — UK | https://careops.uk.awellhealth.com/ |
| Production — US | https://careops.us.awellhealth.com/ |
These are portal addresses for people to sign in to — not API endpoints. See Authentication for creating a key.
An API key belongs to one environment. A Sandbox key does not authenticate against production, and a key from one production region does not work in another. Moving an integration from Sandbox to production means a new key as well as a new endpoint.