To manage data syndications for an entire Acoustic Exchange user account, you can call Acoustic Exchange account level APIs.

An Acoustic Exchange user account can be associated with multiple endpoints, each representing a different business application. In such cases, endpoints for the Acoustic Exchange account can be a combination of event or audience producers or consumers. To call account-level APIs, you must have account level access to Acoustic Exchange in the form of account-level authentication keys and account IDs.

GET /v1/endpoint

Call 'GET /v1/endpoint' with an account-level authentication key to get a description for all endpoints that are associated with a specific Acoustic Exchange user account. The description can include various endpoint characteristics that you specify as additional query parameters in the API call.

About this API

To get descriptions for all endpoints that are associated with a particular Acoustic Exchange account, you must include an account-level authentication key as the authorization bearer for the API call. The authentication key must be an account level authentication key that is provided to you by Acoustic Exchange.
Note: To make this call successfully, you must have access authorization across all endpoints that are registered for the user account.

When you call 'GET /v1/endpoint' with an account-level authentication key, Acoustic Exchange returns descriptions for all endpoints that are associated with the account.

To return information for only one endpoint that is registered to an Acoustic Exchange account, you can include the endpoint ID as a URL parameter in the call.

In the URL for the call, you can include additional optional URL parameters to request specific characteristics for each endpoint that is registered to the account. Separate parameters with '&'.

Request

Direct the API call to the base URL that is assigned to your Acoustic Exchange account.

The response lists the endpoint properties as they were entered during event registration with 'PUT v1/endpoint'.

To specify the user account, provide the authentication key for the account as the authorization bearer in the API call.

Request format (as a curl command):

curl -v 
-X GET 
-H "Authorization: Bearer <account authentication key>" 
<base URL>/v1/endpoint?<parameter 1>&<parameter 2>&<parameter n>

Note: the Authorization Bearer must be an account-level authentication key.

For example, calling the following URL returns descriptions for up to 20 segments that provide audience data from the various endpoints that are registered with Acoustic Exchange on behalf of the Acoustic Exchange account that is associated with the account-authentication key.

Response

Acoustic Exchange public APIs return standard HTTP 1.1 response codes.

'GET /v1/endpoint' provides responses as follows:

DELETE /v1/endpoint/{endpointId}

Delete a specific registered endpoint in Acoustic Exchange. This API call requires account level authorization.
##About this API
Call 'DELETE /v1/endpoint/{endpointId}' remove an endpoint from Acoustic Exchange. Calling 'DELETE /v1/endpoint/{endpointId}' provides the same request options and the same responses as 'DELETE /v1/endpoint'. However, because you call 'DELETE /v1/endpoint/{endpointId}' from the account level, you must specify the endpoint ID as a URL parameter.
##Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
Example request (as a curl command):

curl -v 
  -X DELETE
  -H "Authorization: Bearer 1234-abcd-5678-efgh" 
  -H "Content-Type: application/json" 
  <base URL>/v1/endpoint/<endpointID>

Note: Specify the 'endpointID' as a URL parameter in the API call.

Other than including the endpoint ID as a parameter in the API call, the details of the API request and the API response are the same as 'PUT /v1/endpoint'.

PUT /v1/endpoint/{endpointId}

Register a specified endpoint with Acoustic Exchange. This API call requires account level authorization.
##About this API
Call 'PUT v1/endpoint/{endpointID}' to register an Acoustic Exchange application, or approved Acoustic Exchange Business Partner application, as an endpoint in Acoustic Exchange on behalf of a registered Acoustic Exchange user. Calling 'PUT /v1/endpoint/{endpointId}' API provides the same request options and the same responses as 'PUT /v1/endpoint'. However, because you call 'PUT v1/endpoint/{endpointID}' from the account level, you must specify an endpoint ID as a URL parameter.
##Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
Example request, in this example to register as an event endpoint, (as a curl command):

curl -v 
  -X PUT 
  -H "Authorization: Bearer <1234-abcd-5678-efgh>" 
  -H "Content-Type: application/json" 
  -d '{€œproviderName€ : €œ<name of provider>€,€œname€ : €œ<name of endpoint>€,
     €œdescription€ : €œ<description>€, "endpointTypes" : { "event" : 
     {"<source | destination>" : {  "enabled" : true,  
     "destinationType" : "<push | pull>" }  } }, 
     €œurl€ : €œ<URL for endpoint>€}' 
     <base URL>/v1/endpoint/<endpoint ID>

Note: Specify the 'endpointID' as a URL parameter in the API call.

Other than including the endpoint ID as a parameter in the API call, the details of the API request and the API response are the same as 'PUT /v1/endpoint'.

PUT /v1/endpoint/database

You can use this API to modify the database identification information that is associated with an endpoint.
##About this API
There are some provisioning or integration use cases in which a database name or ID must be modified after endpoint registration. Acoustic Exchange provides the 'PUT /v1/endpoint/database' API if such a use case becomes necessary for your application.
##Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
You can use either an endpoint level or an application level authentication key as the authorization bearer for the call. If you use an application level authentication key, you must include the endpoint ID in the call as a means to identify the endpoint. If you use an endpoint level authentication key, the key is used to identify the endpoint.
Request format (as a curl command):

curl -X PUT 
  <base URL>/v1/endpoint/database 
  -H 'accept-charset: UTF-8' 
  -H 'authorization: Bearer <endpoint or application authentication key>' 
  -H 'cache-control: no-cache' 
  -H 'content-type: application/json' 
  -H 'postman-token: <token>' 
  -d {
      "endpointId": <endpoint ID>,
      "databaseId": "<database ID>",
      "marketingDatabaseName": "<database name>"
}

Response

Acoustic Exchange public APIs return standard HTTP 1.1 response codes.
'PUT /v1/endpoint/database' provides responses as follows.

PUT /v1/endpoint/disable/{endpointId}

If you manage multiple endpoints for an Acoustic Exchange account, you can disable a specific registered endpoint by specifying the endpoint ID when you call 'PUT /v1/endpoint/disable' and specify an account-level authentication key.
##Before you begin
Register one or more endpoints by calling 'PUT v1/endpoint' or 'PUT /v1/endpoint/{endpointId}'.
##About this API
To disable one of multiple endpoints that are registered to an account, you must include an account-level authentication key as the authorization bearer for the API call. The authentication key must be an account-level authentication key that is provided to you by Acoustic Exchange.
##Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
Add the endpoint ID of the endpoint that you want to disable as a parameter to the URL, as shown in the example.
Request format (as a CURL command)

curl -v 
    -X PUT
    -H "Authorization: Bearer <endpoint authentication key>" 
    -H "Content-Type: application/json" 
    <base URL>/v1/endpoint/disable/<endpoint ID>

Response

Acoustic Exchange public APIs return standard HTTP 1.1 response codes.
'PUT v1/endpoint/disable/{endpoint ID}' provides responses as follows.

PUT /v1/endpoint/enable/{endpointId}

If you manage multiple endpoints for an Acoustic Exchange account, you can enable a specific registered endpoint by specifying the endpoint ID when you call 'PUT /v1/endpoint/enable' and specify an account-level authentication key.
##Before you begin
Register one or more endpoints by calling 'PUT v1/endpoint' or 'PUT /v1/endpoint/{endpointId}'.
##About this API
To enable one of multiple endpoints that are registered to an account, you must include an account-level authentication key as the authorization bearer for the API call. The authentication key must be an account-level authentication key that is provided to you by Acoustic Exchange.
##Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
Add the endpoint ID of the endpoint that you want to enable as a parameter to the URL, as shown in the example.
Request format (as a CURL command)

curl -v 
    -X PUT
    -H "Authorization: Bearer <endpoint authentication key>" 
    -H "Content-Type: application/json" 
    <base URL>/v1/endpoint/enable/<endpoint ID>

Response

Acoustic Exchange public APIs return standard HTTP 1.1 response codes.
'PUT /v1/endpoint/enable/{endpoint ID}' provides responses as follows.

GET /v1/endpoint/{endpointId}/segments/{segmentId}

Get the details of a specific audience within an endpoint.
##About this API
Call this API to get a description for a specific audience that is provided or received by an endpoint that is registered with Acoustic Exchange on behalf of an Acoustic Exchange user account. The call requires a valid authentication key, which is specific to the user account and endpoint.
Note: Information that you retrieve for a segment with this API appears in the Acoustic Exchange user interface as details that relate to an audience.
You must provide the following information to call this API:
- Authentication key that is associated with an Acoustic Exchange user account
- Endpoint ID for the endpoint in which the audience is defined
- Segment ID for the segment that you want to describe
You must also have user authorization to access the endpoint.
##Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
Example request (as a curl command):

curl -v 
    -X GET 
    -H "Authorization: Bearer 1234-abcd-5678-efgh" 
    <base URL>/v1/endpoint/<endpointID>/segments/{<segmentID>}

Response

'GET /v1/endpoint/{endpointId}/segments/{segmentId}' provides responses as follows.
Note: If the audience is a string and the query parameter 'includeSegmentIDString' is set to true, then the call returns the 'property id_string' in place of id.

A: Attributes

B: Segment identification

POST /v1/jobs/segmentExport

Create a job to share audience data from a source endpoint to a destination endpoint. Additionally, you can use 'POST /v1/jobs/segmentExport' to upload identity data to the Acoustic Exchange Identity Store.
##About this API
The response that this API provides depends on the producer type of the audience source endpoint.

• If the source endpoint is a PULL audience provider and the destination endpoint is a PUSH audience consumer: Acoustic Exchange automatically performs the entire process of uploading audience data from the source endpoint, joining audience identifiers if possible, and downloading the audience data to the destination endpoint.
• If the source endpoint is a PUSH audience provider: Acoustic Exchange creates the export job but waits for the source endpoint to upload audience data. Acoustic Exchange puts the job in WAITING_TO_RECIEVE_DATA status. To continue the audience sharing process, the source endpoint must call 'POST /v1/jobs/{jobId}/data' to upload the audience data to Acoustic Exchange.
• If the source endpoint is a PULL audience consumer: Acoustic Exchange creates the export job but waits until the consumer audience data is ready to download. When consumer audience data is ready to download, the status of the job changes to READY_FOR_DOWNLOAD. To download the audience data, call 'GET /v1/jobs/{jobId}/segmentDataFiles/{fileName}'.
  Calling 'POST /v1/jobs/segmentExport' from a segment producer endpoint to create a waiting segment export job makes it possible for Acoustic Exchange users to use the Acoustic Exchange user interface to upload audience data from the segment producer endpoint to Acoustic Exchange on demand.
  Note: To make this call successfully, you must have access authorization across all endpoints that are registered for the user account.
  ##Request
  Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
  You must use an account-level authorization key as the authorization bearer for this API call.
  Note: If the audience segment has a string segment ID, then the property 'segmentIDString' should be defined in place of the property 'segmentID'.
  Example request (as a curl command):

curl -v 
  -X PUT
  -H "Authorization: Bearer 1234-abcd-5678-efgh" 
  -d '{
        "endpointID":<source endpointID>,
        "segmentID":<source segmentID>|"segmentIDString":<string segment ID (source)>,
        "segmentName":"<name of the segment>",
        "destinationEndpointID":<destination endpointID>,
        "destinationSegmentName":"<destination segment name>",
        "exportCategory":"<category>",
        "action": "<action type>",
        "sourceIdentifiers":["<soure identifiers>"],
        "destinationIdentifier":"<destination identifier>",
        "attributeMappings":{"<source attribute>":"<destination attribute>"},
        "updateIdentities":true|false
        "minCount":"<integer>",
        "scheduleDetails": {schedule}
       }'
     <base URL>/v1/jobs/segmentExport

The following table describes the JSON payload of the call.

A: Identify the source segment

B: Identify the destination segment

C: Specify the action of the call

D: Specify identity and attribute mapping

E: Indicate whether the Acoustic Exchange Identity Store is to be updated

F: Set minimum number of records

G: Schedule audience sharing

Response

Acoustic Exchange public APIs return standard HTTP 1.1 response codes.
'POST /v1/jobs/segmentExport' provides responses as follows.

What to do next

If the source endpoint is a PUSH audience provider, you can call 'POST /v1/jobs/{jobId}/data' to upload a segment to the export job that Acoustic Exchange holds in WAITING_TO_RECIEVE_DATA state.
If the destination endpoint is a PULL audience consumer, you can call 'GET /v1/jobs/{jobId}/segmentDataFiles/{fileName}' to download audience data.
Specify the job ID that 'POST /v1/jobs/segmentExport' returns.
#POST /v1/jobs/identityImport
Use this API to schedule a bulk upload of segmented identity data to the Acoustic Exchange Identity Store.
##About this API
In most cases, Acoustic Exchange gathers identity data by examining events that are produced and consumed by endpoints. As such, it can take new Acoustic Exchange endpoints that use this process some time to build a large repository of identity data within the Acoustic Exchange Identity Store. However, if your endpoint already has a repository of identity data, you can upload that data in bulk to the Acoustic Exchange Identity Store by using the 'POST /v1/jobs/identityImport' API.
The response that this API provides depends on the producer type of the source endpoint.

• If the source endpoint is a PULL segment producer, the API call initiates the identity data upload and returns a generated job ID. Additionally, it schedules a new job to check the endpoint's export data job status. As a result, Acoustic Exchange periodically checks the jobs status until it reads as complete and the identity data is uploaded.
• If the source endpoint is a PUSH audience provider: Acoustic Exchange creates the export job but waits for the source endpoint to upload audience data. Acoustic Exchange puts the job in WAITING_TO_RECIEVE_DATA status. To continue the audience sharing process, the source endpoint must call 'POST /v1/jobs/{jobId}/data' to upload the audience data to Acoustic Exchange.
  ##Request
  You must use an account-level authentication key as the authorization bearer in the API call.
  Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
  Note: If the audience segment has a string segment ID, then the property 'segmentIDString' should be defined in place of the property 'segmentID'.
  Example request (as a curl command):

curl -v 
  -X PUT
  -H "Authorization: Bearer 1234-abcd-5678-efgh" 
  -d '{
        "endpointID":<source endpoint ID>,
        "segmentID":<source segment ID>|"segmentIDString":<string segment ID (source)>,
        "databaseID":<source database ID>
        "sourceIdentifiers":["<identifier name>, <identifier name>"]
        "scheduleDetails":{
        "runNow":true|false,
        "runRepeat":true|false,
        "daysOfWeek":<day of the week>,
        "daysOfMonth":<day of the month>,
        "monthsOfYear":<months of the year>,
        "year":<the year>,
        "startHour":"<the hour to start>",
        "startMinute":"<the minute to start>",
        "startSecond":"<the second to start>",
        "startDate":"<the start date>",
        "endDate":<the end date>,
        "timeSliceStartDate":<date>,
        "timeSliceEndDate":<date>},
       }'
     <base URL>/v1/jobs/identityImport

The following table describes the JSON payload of the call.

A: Identify the source segment

B: Specify identity and attribute mapping

C: Schedule the identity data upload

Response

Acoustic Exchange public APIs return standard HTTP 1.1 response codes.
'POST /v1/jobs/identityImport' provides responses as follows.