This article will aim to explore configuring the CareAR Web API Connector for workflows with Assist and/or Instruct.
- Consider where in your application’s workflows you want to invoke CareAR Assist or Instruct application.
- If you have information relating to the target CareAR Assist guest participant (i.e., email, mobile phone number), you will want to pass this in the invocation flow to ease and expedite the workflow. Similarly, if you have information relating to the target CareAR Instruct Experience (i.e., specific page of the Instruct Experience), you will want to pass this in the invocation flow to ease and expedite the workflow.
- Upon the completion of a CareAR Assist session, CareAR provides a way to return the host user to the invoking application.
- When configured in the Connector center profile for the custom Connector, CareAR will send (via HTTPS POST) details about the session, pictures that may have been created during the session, and URLs to video recording files that may have been created. To get the most out of CareAR Assist, you’ll need to create a web service that can receive this data and affix to your service object/record.
Custom CareAR Web API implementations require the tenant to be subscribed to an appropriate subscription plan. You can confirm your plan type in the CareAR Admin Portal under the Administration screen.
There are two considerations for authentication when using the CareAR Web API.
There is the initial launch of the CareAR Assist session and the return data from the CareAR Assist/Instruct session. The initial HTTPS GET used to launch CareAR must include the auth token as defined in the Connector center within the CareAR Admin portal. Auth tokens are easily created and managed in the Connector management screen of the CareAR Admin Portal. The tenant administrator will need to create your custom Connector auth token.
For the callback function, the HTTPS POST request will require Basic authentication. This uses the service account username and password pair that are defined in the custom Connector profile.
NOTE: The web service will need to be available in the implementer’s domain to receive CareAR data. It is generally considered best practice to create a service account in your web service to use for the Web API to post to your application.
Configure the CareAR Connector
In order to obtain the auth token used by the point of initiation as well as to configure the CareAR return traffic can be done by a tenant administrator within the Connector section of the CareAR Admin web portal (https://carear.app/#/admin). Once on the Connector screen selecting Web API will navigate the tenant administrator to the following screen:
For the return traffic from a CareAR session the values for the following will be needed:
- API Username
- This would be the account user name used for the basic authentication of the return traffic back to the implementer's domain
- API Password
- User account password that pairs with the API Username used in the basic authentication of the HTTP Post traffic being returned from CareAR
- Destination FQDN
- The base FQDN of the implementer's domain where CareAR return traffic is to be sent.
- For example with a base FQDN of https://carear.com the value to enter would be carear.com
- Destination Path
- The rest of the URL, if required, of where return traffic to the desired endpoint should navigate to
- For example with an implementation URL of https://carear.com/ReturnTraffic/MyData.aspx the value to enter would be /ReturnTraffic/MyData.aspx
For the auth token value that will be need on the initiator side can be generated by clicking 'Generate new token'. This value will be needed for the initiation URLs for both Assist and Instruct workflows.
NOTE: Generating a new token will invalidate the previous token if one existed prior.
Initiating the Web API Invocation
Assist and Instruct have some slight difference in parameters used for invocation. Please navigate to the appropriate article below for invocation of the workflow(s) you are aiming to implement.