API Overview

The Codero API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate the result of the API calls. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. All responses will be returned in JSON, including errors.

Authentication

Authentication to the Codero API is achieved by providing your API key in the request. All API requests must utilize HTTPS; any calls made via HTTP will fail. All requests to the API must be authenticated with your API key. For example:

Errors

Codero uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, etc.), and codes in the 5xx range indicate an error with Codero’s servers.