Http Request

Before using the API, users need to make sure the HTTP request follows the format below.

HTTP Request Header​

Ensure that the following HTTP request headers are included in your requests:

The values for these headers can be copied from the "API Keys" tab of the "Settings" page in the OneRewards web application.

HTTP Request Body​

Please note that body objects required in any requests are JSON objects.

In addition, all requests containing a body object should have the "Content-Type" header present with value "application/json".

All requests with parameters in the body are required to pass an empty object in JSON string at the very least. Meaning in order to return an empty body object in the request, your request body would look like this:

{}

HTTP Response​

The table below shows the HTTP Response Codes returned by Integration API.

The response code is returned to indicate if the request succeed or fail.

Error Response​

When the API call failed, it will return an error response and a message to indicate what causes an error to occur.

Response Body​

{
    "statusCode": 401,
    "message": "401 Unauthorized."
}