Skip to main content

API User Guide

REST API Functions

The REST APIs encrypt requests and data and provide responses using Transport Layer Security (TLS).

The combination of HTTPS method and API URL is referred to as an "endpoint." Each REST API endpoint is documented in Swagger, and is characterized as follows:

  • It is "stateless"—that is to say, no context is stored, and each client needs to provide all the necessary information to service each request.

  • It is "cache-able"—that is to say, the client's intermediary can store the responses for subsequent retrieval.

  • It uses a uniform interface—all responses are provided in JavaScript Object Notation (JSON) format.


    JSON is a convenient format for representing REST resources because it is human-readable, easily compressed, and all modern programming languages support it. It is also easy to understand because it only has a few data types (StringNumberBoolean, Null, Object, and Array).