Authentication

API token

Every request must send your API token as a Bearer token in the Authorization header. You can get the token from the Easify app under Settings > API Settings.

Required headers

Send both of these headers on every request:

Authorization: Bearer <>
Accept: application/json

Without Accept: application/json, a request that fails validation on some endpoints gets a 302 redirect instead of a JSON error.

A missing or invalid token returns HTTP 401:

{
  "status": false,
  "message": "Unauthenticated",
  "errors": []
}

IP whitelist

Requests are accepted only from IP addresses or domains on your account's API whitelist, which you can manage under API Settings in the Easify console. Whitelisting is turned on by default, so add your server's public IP address before your first call. Domain entries are matched against the request's Origin header, which most server-side HTTP clients do not send, so server-to-server integrations should whitelist by IP. Changes can take up to one minute to apply.

A request from an address that isn't whitelisted returns HTTP 400:

{
  "status": false,
  "message": "Access denied! Your IP or domain is not whitelisted.[ HostName : ] - [ Ip Address : 203.0.113.10]",
  "errors": []
}