Integration API
Use this API to request sleep studies via the Acurable platform.
This API provides the ability to:
- Create and cancel in-house studies
- Create and update orders
- Create referrals
Who can use this API
This service is intended for customers who have a commercial relationship with Acurable.
If you do not yet have a commercial relationship with us, or you would like to trial our solutions, contact us through our website.
This service is available to customers in the following regions:
- UK
- European Union
- USA
Service level
This service is available 24 hours a day 365 days a year and is supported from 9am to 6pm (UK time), Monday to Friday excluding bank holidays.
Support is available via our [email protected] email address. Response times will be dependent upon the SLA we have agreed within your contract.
If you do not yet have a contract with us we aim to respond to support requests within 3 business days.
Technology
This API is a REST-based API.
We follow the JSON:API standard for our request and response schemas.
Response content types
This API can generate responses the format application/json.
This API will ignore any attempt to change this through use of the Accept header.
Request content types
This API will accept request payloads of the type application/json.
The Content-Type header on all of your requests sending content must include this value.
If you do not sent this value then the API will respond with a 415 Unsupported Media Type response.
Network access
This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN).
Security and authorisation
This API is application-restricted, meaning we authenticate the calling application but not the end user.
Authentication and authorisation of ens users using this API is the responsibility of your application.
To access this API you must use credentials issued as part of your onboarding to generate an access token from our OIDC Identity Provider.
Environments and testing
Test environment
Our test environment is for early developer testing & MVPs.
This environment is designed for customers who need to test upcoming work in progress on our platform against their integration.
Pre-production environment
Our pre-production environment is for formal integration testing & acceptance.
This environment runs the same version of our platform as our production environment.
Onboarding
You need to get your software approved by us before it can go live with this API.
See the steps for onboarding.
Errors
We use standard HTTP status codes to show whether an API request succeeded or not. These are usually in the range:
- 200 to 299 if it succeeded
- 302 if you must follow a new URL to fetch the resource requested
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our service
Errors specific to each API call are shown in the endpoints section, under responses.
Authentication
- OAuth 2.0: bearerToken
Security Scheme Type: | oauth2 |
|---|---|
OAuth Flow (clientCredentials): | Scopes: |