Authorization and Authentication

Allowed IP Addresses

All requests to any COS API must come from a whitelisted source IP addresses, currently IPv4 only.

This includes any workstations, offices, and servers used for development also. Before continuing, you will need to provide COS a list of any and all IPv4 addresses that will originate calls to the API.

HTTP Headers

There are two headers that are required in every HTTP call to the COS API.

• Authorization, the value of which is the API key you will receive from COS.
• BusinessEngine, the name of the COS environment, provided by COS, your API call is targetting.

Below is an example API request utilizing the headers required to successfully utilize the API.

curl -X 'GET' \
  'https://acme123.test.partnerapi.net/v1/Object/List' \
  -H 'accept: application/json' \
  -H 'BusinessEngine: acme123-prod' \
  -H 'Authorization: secretapikey'