Requests
How to make API requests
Last updated
How to make API requests
Last updated
An API request consist of:
: GET
, POST
or DELETE
: authorization and content type
: HTTPS, environment, service, method and parameters
which contains the payload
The API supports
GET
to get a specific JSON object, like a purchase order, or to download a document (one JSON object or document is returned) or to query objects (a JSON collection is returned)
POST
to create a new JSON object or upload a document
DELETE
to delete an existing JSON object or document
Use the Authorization
header for basic authentication and token authorization, see
Use the Content-Type: application/json
header in case of a POST
with a JSON body.
Use the Content-Type: application/xml
header in case of a POST
with an XML body.
An URL is build up like this: https://environment/service/method/parameters?parameters
Common used services are:
authentication
for authentication, to get a token
api-connector
for buyer and supplier ERP integration
object-storage
to upload and download documents
order
for order/line commands
order-search
for order queries
order-line-search
for order-line queries
sci-connector
for buyer ERP integration using SCSN
POST /api-connector/order-response
sends an order response by the supplier
A request can have a path parameter such as an {id}
in object-storage
service download
method:
A GET request can have a query parameter such as a query
in company-search
:
A POST request has a JSON body (payload), such as a purchase order sent to the api-connector
service order
method:
The Tradecloud API supports a proprietary XML format, called tXML
, which is a 1-on-1 translation of the proprietary JSON format:
A POST request has a tXML
body (payload), such as a purchase order sent to the api-connector
service order
method:
The API uses the software architectural style that defines a set of constraints to be used for creating Web services. The API additionally uses a command and query style.
The API only supports HTTPS, see .
Tradecloud has :
have a short dynamic life cycle and have NO availability SLA
the has an availability SLA of 95% 10/5
the has an availability SLA of 99.5% 24/7
Each environment has a set of services which you can find on each environment page, like the and
On the environment page for each service the API endpoint you can find the file, the OpenAPI UI rendering, the health and label (version) is published.
In each you can find the methods supported by the service. For example the service:
POST /api-connector/order
Most service methods have either path parameters, query parameters and/or a or
The Tradecloud API supports a proprietary format:
JSON is a standard published as and
JSON text
JSON strings:
JSON strings: for date/time values date format YYYY-MM-DD
or local date/time format YYYY-MM-DDThh:mm:ss
is used
Tradecloud supports :
Following the for some api-connector
and order-webhook-connector
API endpoints.
Following the for the sci-connector
API endpoint.
XML text
A sci-connector
POST request has a body (payload), such as a purchase order sent to the sci-connector
service order
method:
XML text