Public SalesForce Integration Service APIs 1.0

Server

/api/v1.0/

Authentication

FlowImplicit

Authorization URLhttps://ao.adara.com/api/

Scopes

Name	Description
No scopes

Get a client's available signals

Auth

Path Params

endpoint_owner_id	string	pattern: `^[a-zA-Z0-9-]+$`
client_id	string	pattern: `^[a-zA-Z0-9-]+$`

GET /signals/{endpoint_owner_id}/{client_id}

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//signals/%7Bendpoint_owner_id%7D/%7Bclient_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully returned list of intel scores

object	object
active	boolean	feature flag indicating that the endpoint is interactive
response	object
signals	array[object]
code	string	the machine readable identifier used in API calls and bulk update file headers.
name	string	the human readable name that should be displayed to business consumers.
type	string	the expected data type of the returned signal value.

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

404

Item Not Found

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "signals": [   {    "code": "TVS",    "name": "Travel Value Score",    "type": "boolean"   }  ] }}
Copy

Upload a csv of hashed emails for a particular customer

Auth

Path Params

endpoint_owner_id	string	pattern: `^[a-zA-Z0-9-]+$`
client_id	string	pattern: `^[a-zA-Z0-9-]+$`

Request Body

object	object
type	string
hash_type	string
records	array[string]

POST /upload/{endpoint_owner_id}/{client_id}

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//upload/%7Bendpoint_owner_id%7D/%7Bclient_id%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "type": "email",  "hash_type": "sha256",  "records": "31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66"}'
Copy

Responses

200

Successfully uploaded a file

object	object
active	boolean	feature flag indicating that the endpoint is interactive
response	object
file_id	string	unique id uploaded file
created	integer	unix timestamp of file upload time in seconds

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "file_id": "{string}",  "created": "{integer}" }}
Copy

Trigger a bulk score update for a SalesForce client

Auth

Path Params

endpoint_owner_id	string	pattern: `^[a-zA-Z0-9-]+$`
client_id	string	pattern: `^[a-zA-Z0-9-]+$`

Request Body

object	object
signals	array[string]
salesforce_auth	object
isSandbox	boolean
namespace	string
orgId	string
orgInstance	string
refreshToken	string

POST /trigger/{endpoint_owner_id}/{client_id}

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//trigger/%7Bendpoint_owner_id%7D/%7Bclient_id%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "signals": [    "{array[string]...}"  ],  "salesforce_auth": {    "isSandbox": "{boolean}",    "namespace": "{string}",    "orgId": "{string}",    "orgInstance": "{string}",    "refreshToken": "{string}"  }}'
Copy

Responses

200

Successfully returned list of intel scores

object	object
active	boolean	feature flag indicating that the endpoint is interactive
response	object
created	integer	unix timestamp of file upload time in seconds
job_id	string	unique id for the update request

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "job_id": "{string}" }}
Copy

Get the current job status & results

Auth

Path Params

job_id string

GET /status/{job_id}

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//status/%7Bjob_id%7D'
Copy

Responses

200

Successfully returned list of intel scores

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive
response	object
created	integer	unix timestamp of file upload time in seconds
job_id	string	unique id for the request
updated	integer	unix timestamp of file upload time in seconds
status	string
results	object

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "job_id": "{string}",  "updated": "{integer}",  "status": "{string}",  "results": {} }}
Copy