Page tree
Skip to end of metadata
Go to start of metadata

For instructions on how to find the relevant endpoint for the REST API, see Introduction to Jade APIs.

Introduction

The Jade User REST API and Jade Admin API REST API, and Jade Open REST API use REST (Representational State Transfer) as an API protocol. Data is encoded in JSON.

The Jade User REST API and Jade Admin API REST API, and Jade Open REST API use REST (Representational State Transfer). A client program sends a REST request; the web service processes the request and sends a response. Both the request and the response are packaged as JSON messages that have a header and a body.

For the Jade APIs, all API messages are sent via HTTPS requests. The JSON for the REST request is sent as an HTTP request with a special RESTAction header; the response is sent back as the response to the POST. All Jade User API and Admin API calls are encrypted with SSL (that is, as HTTPS) to protect the privacy of your data. 

The header describes metadata about the message. This should contain the authentication token used to authenticate to the REST API.

  • No labels