API Only Integrations

When implementing a API Only integration, you are providing the entire UI of your application and not using any Blueprint user interface components. This gives you complete control over the user experience for your users, but requires that you implement device access, audio capture, user feedback, and so on.

In this integration method, the clinician user will be authenticated to your application. Your backend will call Blueprint APIs to create a clinician record for that user in Blueprint (if they do not exist). This clinician record is needed in Blueprint to associate clinicians, clients, and session; your backend only needs to authenticate with the Blueprint API for server-to-server calls.

To generate clinical artifacts from audio, Blueprint needs to have a record for the client being treated. Your backend will call Blueprint APIs to create clients based on the clients in your application. Your application will capture audio and then your backend will send it to the Blueprint API, indicating which clinician and client are associated with the recording.

The workflow of implementing a API Only integration looks like this:

1. Your partner organization will be provisioned by Blueprint with an API client id, API client secret, and API key.

   1. These are secrets that should be stored securely with your application backend and never shared to front end code.

2. Your application backend will authenticate with Blueprint using the API client id and API client and will receive an access token to be used (along with your API key) for subsequent server-to-server calls. This is the server-to-server access token.

3. Your application backend will create clinician records in Blueprint for the users of your application. You can provide an external id of the clinician (for example, the user id in your application) that will be stored in Blueprint.

4. Your application backend will create client records in Blueprint for the clients in your application. You can provide an external id of the client (for example, the medical record number of the patient in your application) that will be stored in Blueprint.

5. Your application will record or capture audio and then upload it to Blueprint via API.

6. When the clinical artifacts are ready, the Blueprint backend will send a webhook to endpoints that you have implemented. Typically the payload of each webhook will have metadata about the event that happened, and relevant internal ids that your backend can then use to fetch additional details via the Blueprint API. Your application backend can then process and store these artifacts as needed.