Some Salesforce accounts require that it's users update their login credentials on a regular basis. To update your login credentials in Acoustic Exchange, you must call the Acoustic Exchange API PUT v1/endpointattributes
.
About this API
If you update your Salesforce login credentials after you have established your Salesforce application as an endpoint in Acoustic Exchange, and do not update the credentials in Acoustic Exchange, the integration fails and data no longer flows from Salesforce to Acoustic Exchange and vice versa.
The v1/endpointattributes API provides connection and login information as attributes in the JSON payload of the call. The specific attribute names and values must include your Salesforce username, password, and security token. After the call is made, Exchange retrieves the information that you provide in calls to v1/endpointattributes nightly. As such, allow 24 hours for your login credentials to be updated in the Acoustic Exchange database.
Request
Direct the API call to the base URL that is assigned to your Acoustic Exchange account.
The call accepts an authentication key as a URL parameter. Enter the authentication key that was used to register the endpoint for which you are configuring access. The authentication key is unique to the endpoint and the specific Acoustic Exchange account that requested the endpoint registration. The authentication key is required as a URL parameter and as the authorization bearer in the header of the call.
Example request (as a curl command):
curl -v \
-X POST \
-H "Authorization: Bearer 1234-abcd-5678-efgh" \
-H "Content-Type: application/json" \
-d '{“name” : “<access attribute>”,“name2” : “<access attribute2>”}' \
<base URL>/v1/endpointattributes/authkey/"1234-abcd-5678-efgh"
The following table describes an example JSON payload of the call.
JSON |
Requirements |
---|---|
|
A. Enter connection and authentication attributes. |
A. Enter connection and authentication attributes
You can enter multiple name and value pairs in the API call.
Property | Use | Data type | Valid value | Description |
---|---|---|---|---|
Attributes | Required | Enter connection details and authentication credentials as defined by the endpoint. | ||
name | Required | As defined by the endpoint. | As defined by the endpoint. |
Name of the connection or authentication attribute. For example: "clientSecret" |
value | Required | As defined by the endpoint. | As defined by the endpoint. | Enter the value that the endpoint specifies and requires. The value is specific to the Exchange account that needs to access the endpoint. |
Response
Acoustic Exchange public APIs return standard HTTP 1.1 response codes.
PUT <base URL>/v1/endpointattributes/authkey/"<account authentication key>" provides responses as follows.
Code | Description |
---|---|
200 - 299 |
Success. Acoustic Exchange received the connection and authentication values and associated them with a registered endpoint and Acoustic Exchange account. |
400 - 499 |
There is a problem with the API request. Examine the request for errors. |
500 - 599 |
System error. Contact support for assistance. |