Overview

All APIs adhere to REST protocols and leverage standard HTTP methods such as GET, POST, PUT, and DELETE to perform operations on resources. Responses will retuen the appropriate HTTP status code to indicate success or failure of the request. All input and output payloads will be in JSON format where applicable. All endpoints are stateless.

APIs are associated to one or more Products. To gain access to an API, browse to Products and select the product you wish to subscribe to. Once the product detail page is open, specify the Name (this is your reference) of the subscription and click Subscribe.

To see the APIs that are available to you, browse to APIs.

  • Products/APIs indicated as LIVE is the production environment.

  • Products/APIs indicated as TEST is the testing/sandbox environment used for testing purposes.

All endpoints require a Subscription Key to be sent as part of the request. See Authentication for more details on this.