Custom endpoints

Acoustic Exchange supports registering your business solution as a custom endpoint. You build custom endpoints separately in response to each registration request. This approach does not define your solution as an Exchange application with globally accessible features.

Note: Registering endpoints as custom endpoints is not recommended for new integrations with Exchange. It is documented here to support legacy integrations.

As an Exchange partner and endpoint provider, building custom endpoints – instead of basing the endpoints on an Exchange application definition – means that you must build a separate endpoint for each registration request. If the endpoint changes, you must individually update the endpoint registration for every Exchange user account that has registered the custom endpoint. For example, if you begin to support a new event type or identifier six months after you are provisioned as an Exchange endpoint provider, you must separately update the registrations for every Exchange user account that registered your endpoint as a custom endpoint during the previous six months.

To build each endpoint, you must call the v1/endpoint API to describe the endpoint and to describe events or audience data that it can provide. Exchange uses the information from the API call to present the endpoint as an option in the Exchange user interface.

Exchange communicates with endpoints through APIs and HTTPS. If your application or service requires authenticated access, call the v1/endpointattributes API to provide Exchange with the specific credentials that you require to establish a secure connection. Creating a custom endpoint requires calling Exchange public endpoint APIs that are different from the v1/application APIs that you call to create and provision endpoints as Exchange applications. You call the endpoint APIs separately for each Exchange user that registers your endpoint as a custom endpoint.

To register your business solution as a custom endpoint requires that you call the v1/endpoint and v1/endpointattributes APIs.

You must individually define the endpoint for each Exchange user that registers your business solution in Exchange. This means that you must call v1/endpoint and v1/endpointattributes for each request. If you make changes to the endpoint, for example, to support a new identifier in the audience data, you must update each registered endpoint individually.