Authentication

Follow

You can find your API key under Account Settings; hover over your initials and select "Account Settings."

 

1.png 

 

Saleswhale expects the API key to be included in all API requests to the server. Provide your API key as the value of a "token" parameter in the request data body. It's important to include the header "Content-Type: application/json" to every request.

 

cURL Example:
curl "https://engage-api.saleswhale.com/api/{api_endpoint}" -X POST -H "Content-Type: application/json" -d "{\"token\":\"<YOUR_API_KEY>\"}"  

 

Errors

Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON. The various HTTP status codes we might return are listed below.

200     OK  The request was successful.
201 Created  The resource was successfully created.
400 Bad Request  Bad request.
422 Unprocessable  Error Validation or missing attribute error.
429 Too Many Requests  Rate limit is exceeded. Limit is 5 requests per second.
401 Unauthorized Your API key is invalid.
404 Not Found The resource does not exist.
500 Internal Server Error    An error occured with our API.
409 Time Out Error Your session timed out.

 

 

1 out of 1 found this helpful

Comments

0 comments

Article is closed for comments.