API Response

Interpreting API responses.

Overview

When you send a request to the Savitar’s API, you receive a response that includes an HTTP status code and a JSON formatted response body.

To determine your request’s status, use the HTTP status code along with the status from the response:

  • A status set to ok indicates the request succedeed and the field response contains the response data.
  • A status set to nok indicates an error occured during the processing of the request. Refer to code and message to handle errors.

Success

{
  "status": "ok",
  "response": Array|Object
}

Error

{
  "status": "nok",
  "code": string,
  "message": string
}