Standards
Overview of standards used by the Tradecloud API and webhooks
Last updated
Overview of standards used by the Tradecloud API and webhooks
Last updated
Your integration must support these standards.
is a simple HTTP authentication scheme built into the HTTP protocol. The client sends HTTPS requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password
Published as
Basic authentication is supported by both the API v2.0 and webhooks.
is an HTTP authentication scheme that involves security tokens called bearer tokens. The client send HTTPS requests with the Authorization header that contains the word Bearer followed by a space and the token.
Published as
The bearer token is supported as part of by the API v2.0.
The bearer token is supported as part of and as static token by the webhooks.
The is a stateless application-level protocol for distributed, collaborative, hypertext information systems.
HTTP 1.1. is published as and RFC 7231 to 7237.
HTTP 2.0 is published as
The JSON syntax does not assign any significance to the ordering of name/value pairs.
Therefor XML based transformations expecting ordering will break.
JWT is supported by the API v2 only (and not by the webhooks).
A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource.
Since URLs often contain characters outside the ASCII set, the URL has to be converted into a valid ASCII format. URL encoding replaces unsafe ASCII characters with a "%" followed by two hexadecimal digits. URLs cannot contain spaces. URL encoding normally replaces a space with a plus (+) sign or with %20.
ISO/IEC 10646-1 defines a large character set called the Universal Character Set (UCS) which encompasses most of the world's writing systems. The originally proposed encodings of the UCS, however, were not compatible with many current applications and protocols, and this has led to the development of UTF-8
Tradecloud does not assign any significance to the ordering of XML tags.
Therefor XML based transformations expecting ordering will break.
Date/time values use date format YYYY-MM-DD or local date/time format YYYY-MM-DDThh:mm:ss
Published as
Tradecloud supports JSON and . JavaScript Object Notation (JSON) is a lightweight, text-based, language-independent data interchange format.
Published as and
The Tradecloud apply to the JSON usage.
are an open, industry standard method for representing claims securely between two parties.
Tradecloud supports a sub set of the .
is an authorization protocol that gives an API client limited access to user data on a web server. OAuth relies on authentication scenarios called flows, which allow the resource owner (user) to share the protected content from the resource server without sharing their credentials. For that purpose, an OAuth 2.0 server issues access tokens that the client applications can use to access protected resources on behalf of the resource owner.
Published as
The is supported by the order webhooks only (and not by the API v2 or shipment webhook at this moment).
The creates a RESTful interface for easily developing and consuming an API by effectively mapping all the resources and operations associated with it.
is not a standard but a software architectural style that defines a set of constraints to be used for creating Web services. The Tradecloud API additionally uses a command and query style.
is a cryptographic protocol designed to provide communications security over a computer network.
The Tradecloud API only supports published as and published as
Published as with .
can only be sent over the Internet using the .
Published as
Tradecloud supports XML and . The its main purpose is serialization, i.e. transmitting arbitrary data.
Published as
The Tradecloud apply to the XML usage.