To grant Acoustic Exchange permission to interact automatically with the endpoint on behalf of an Acoustic Exchange user, the endpoint must provide connection and authentication information by making an API call to Acoustic Exchange.
Acoustic Exchange users register your endpoint with Acoustic Exchange to grant permission for your endpoint to interact with Acoustic Exchange on behalf of the user. As part of the registration process, the user provides the access credentials that they use to authenticate with your systems. As part of the endpoint registration process, Acoustic Exchange generates a unique authentication key to identify the user. The user must provide the key to you. You specify how the user must submit the authentication key.
If you use the v1/application API to provision your endpoint, Acoustic Exchange can provide either of two methods to enable the user to securely provide their access credentials and the authentication key. You can use the Acoustic Exchange onboarding API to provide instructions to the user for how to contact you and provide the credentials and the authentication key. However, to provide a more direct way to provide the credentials, you can call the onboarding API and specify properties that instruct Acoustic Exchange to provide fields in the Acoustic Exchange endpoint registration wizard that can accept the credentials.
To provide Acoustic Exchange with connection information and the authentication credentials that you receive from the Acoustic Exchange user, call the v1/endpointattributes API. Providing connection and authentication information in the secure API call avoids human intervention and possible compromise of secure information. The call to v1/endpointattributes requires an authentication key in the URL and in the HTTP header of the API call.
Acoustic Exchange uses the connection and authentication information that it receives through the API call to connect automatically with your endpoint and to provide authentication credentials.