RekoMile APIs

Introduction

Learn how to integrate our APIs into your application

API Basics

The RekoMile API gives you access to pretty much all the features you can use on our site and lets you extend them for use in your application. It strives to be RESTful and is organized around the main resources you would be interacting with - with a few notable exceptions.

Sample Requests

We provide sample API calls next to each method using cURL. All you need to do is insert your specific parameters, and you can test the calls from the command line. See this tutorial on using cURL with APIs.

Requests and Response

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

{
	"sucess": [boolean],  // Only true if the details provided could be processed and no error occured while processing
	"message": [string], // Explains why status is false... Entirely informational. Please only log this but do not use for your checks
	"data": [object]    // contains actionable result of processing if present
}

While we generally recommend that developers use HTTP status codes to determine the result of an API call, we have provided a handy success key to let you know upfront if the request was successful or not.

The message key is a string which will contain a summary of the response and its status. For instance when trying to retrieve a list of posts, message might read “Posts retrieved”. In the event of an error, the message key will contain a description of the error as with the authorization header situation above. This is the only key that is universal across requests.

The data key is where you want to look at for the result of your request. It can either be an object, or an array depending on the request made. For instance, a request to retrieve a single post will return a post object in the data key, while the key would be an array of customers if a list is requested instead.