Api2.JetAdvice.com

Documentation

This document describes the interfaces and usage of the JetAdvice REST APIv2.

Each endpoint have an associated documentation page. Samples and further documentation are available for each endpoint.

Preconditions

To consume JetAdvice REST API you must have an active JetAdvice account and the user must be API enabled i.e. have API Role (contact your reseller to get access). Many operations requires the
calling JetAdvice account to have specific privileges, as detailed by the operation.
If the client designs a web portal or backend service to consume JetAdvice APIs, then it should make sure that the user running web portal or backend service must have privilege to access the url https://api2.jetadvice.com.

All operations execute with the privileges of the calling JetAdvice user, but some operations requires a customer ID to set the scope of the
requested operation and data.

Authentication

All Service calls requires authentication via a token key.

The token key is obtained through a call to the login endpoint, and must be passed on in a Http header, (case-sensitive), as:
X-AuthKey:{token}
Example:
X-AuthKey:ZTFGCXCTLYAAYEZZLPWL
Alternatively, the token key can be passed as a querystring parameter (case-insensitive):
https://api2.jetadvice.com/customers?x-authkey={token}
Please note that the token key is temporary, and will only persist through the current session. After approximately minutes of
inactivity the token will expire.

If the token key is missing or invalid, the response code will be '403 Forbidden'

Response

Format

By default, response is in JSON format except for following endpoints:

GET Reports Run ednpoint (/reports/run?...) (Default format = Xml)

GET Reports Run Result endpoint (/reports/runResult?...) (Default format = Xml)

Please use Http header Accept to control the format of Response returned by JetAdvice Api.
For more info about http accept header, please read more on w3.org.

Format

Accept header value

xml

application/xml, text/xml

json

application/json

Error handling

We do provide some response content on failed calls. The format of the response on errors will be plain text containg error information to
help you honor preconditions. If the plain text response on errors causes you any integration problems, please contact EuroForm A/S.