When your application is available to the public, Acoustic Exchange users access your solution or product by registering your application as an endpoint in their Acoustic Exchange account. You must process the registration requests.
To enable Acoustic Exchange users to register endpoints in their account, Acoustic Exchange provides an endpoint registration wizard in the Acoustic Exchange user interface. Users access the registration wizard through the Register new endpoint link on the Endpoints tab in Acoustic Exchange.
Although each registration request creates an endpoint registration that is unique to the Acoustic Exchange user that requests it, all of the endpoint registrations for your product or solution are based on the same Acoustic Exchange application. This one-to-many relationship makes it possible for you to update your application and quickly propagate the changes and updates to all users who register your endpoint.
To submit a registration request, users complete the following steps.
Procedure
- Select an application to register as an endpoint. The wizard lists all Acoustic Exchange applications that are available for registration, including yours. Users learn about your application by reviewing a brief description that you defined as part of your Acoustic Exchange application.
- Enter user credentials. If you implemented the Direct Connect registration method (and configured the application to prompt the user), the wizard prompts the user to provide the information that you require to access your user authentication systems. If you implement instructions only, the wizard displays the instructions that you provided as part of your application definition.
- Submit the registration request. When an Acoustic Exchange user requests an endpoint registration in the Acoustic Exchange user interface, Acoustic Exchange generates a unique authentication key. The authentication key must be in the authorization bearer of each API call, including registration requests.
When the Acoustic Exchange user submits the registration request, Acoustic Exchange generates a unique authentication key that is specific to the Acoustic Exchange user account and the request to register your application as an endpoint in that account. Acoustic Exchange makes an HTTPS POST call to your provisioning system that includes the authentication key in the request header. Your provisioning system must be able to accept and process the call. The call provides registration information that resembles the following example.
Authentication: {<authentication credentials as defined for the Exchange application>}
{
"onboardingType" : "<DIRECTCONNECT | INSTRUCTIONSONLY>",
"authKey" : "{<endpoint-level authentication key>}"
"endpointId" : {<endpoint id>},
"extraFields" : [ {extra name-value pairs that users can populate} ],
}
After you validate the request and complete other account provisioning tasks that your systems requires, you make an API call back to Acoustic Exchange to complete the registration.
The implementation page in the Integration Manager describes the required API calls, based on the provisioning method that you specify in your application design. Confirming in advance that this process works for Acoustic Exchange users is part of the testing phase that you perform prior to being approved during the validation phase.
`