Authentication

All requests to all endpoints will require your unique API key. Data2CRM.API designs a unique API Key for you that is used for the identification and authorization of each request.

Note: your API key must be kept private, and should never be displayed publicly.

To authenticate with Data2CRM.API, you need to specify your API key in the header of HTTP request by using an extended header field with the name X-API2CRM-USER-KEY.

Check out the example:


# Request
curl -X GET \
     --header "Accept: application/json" \
     --header "X-API2CRM-USER-KEY: <your_user_key>" \
     "https://api-2445581398133.apicast.io:443/v1/application"

# Response (auth passed)
HTTP/1.1 200
[
  {
    "key": "<your_crm_key>",
    "type": "Salesforce",
    "authorization": "oAuth-internal",
    "description": "Salesforce demo CRM"
  }
]


# Response (auth error)
HTTP/1.1 401
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unauthorized",
  "status": 401,
  "detail": {
    "code": "SERVICE_UNAUTHORIZED",
    "message": "Authorization to service failed. Check service credentials"
  }
}

You can send this request via a sandbox on our interactive documentation. Try request now

Note: the solutions should not call the Data2CRM.API suite using the client-side javascript. This will expose your API key to users of your application. It’s highly recommended to build a server-side endpoint to proxy traffic to and from Data2CRM.API if the direct access is necessary.

CORS headers are disfavoured in our offering and will be removed at a future date.