Nodalio API Technical Documentation

  1. Home
  2. Docs
  3. Nodalio API Technical Documentation
  4. API Security

API Security

Nodalio REST API uses Bearer authentication (also called token authentication) to authenticate all requests to the API. To enter your token, add a header to the POST request.

Key (Header name) Value (Header Body)
Authorization Bearer yourtoken

The token entered after the word “Bearer” is read and authenticated before any requests are made to the API.

Running Shortcodes with the API:

Shortcodes are divided to 2 parts when used in the API. There is no need to enter the sudo or the nodalio prefixes. The shortcode name, for example, “cacheon”, and the action, for example, “opticache”. The shortcode name and action are sent via the body of the POST request, as opposed to the authentication token which is sent via the header of the POST request.

Key (Body key title) Value (Body key value)
shortcode_name cacheon
shortcode_action opticache

Please note: all requests must include a Content-Type header, with a value of application/x-www-form-urlencoded.

Key (Header name) Value (Header Body)
Content-Type application/x-www-form-urlencoded

API Rate Limiting:

Rate limiting in the API limits IP’s from making more than 120 requests in a 1-minute time-frame, including failed requests (bad token for example). With all requests 2 headers are returned for the purpose of tracking the remaining allowed requests.

Key (Header name) Value (Header Body)
X-RateLimit-Limit 120
X-RateLimit-Remaining The number of requests left
  • X-RateLimit-Limit – specifies the number of allowed requests in a 30-minute time-frame.
  • X-RateLimit-Remaining – specifies the number of remaining API requests before the user will be rate limited.
  • Once the user reaches the limit, all requests will be blocked and an HTTP status code 429 will be returned.

Response Body Example:

Key (Body key title) Value (Body key value)
result failure
rate-limit true
data Too many requests, please try again later
Was this article helpful to you? Yes No

How can we help?