1 Header element
There are two ways to use the Header element for proper authentication. You can supply the ApiKey and ApiSecret elements to the Header element as described below. Another way and maybe more secure when using an Ajax Proxy is to leave the ApiKey and ApiSecret elements blank and use Basic HTTP Authentication.
1.1 Basic HTTP Authentication
To use Basic HTTP Authentication you can use your client framework to use ApiKey as username and ApiSecret as password. If your client framework doesn't supply authentication mechanisms, you have to add a special HTTP
Authorization Header to the request manually.
The
Authorization Header has a special format:
Authorization: Basic (base64encoded credentials)
Example
First we have to set up some example credentials.
ApiKey: 00D8DDFE-86BF-4913-A3A3-4F12FD252EA6
ApiSecret: secret
To get the correct header value you need to concatenate ApiKey and ApiSecret by a ':' and encode the whole string with Base64.
Concatenated:
00D8DDFE-86BF-4913-A3A3-4F12FD252EA6:secret
Base64-encoded:
MDBEOERERkUtODZCRi00OTEzLUEzQTMtNEYxMkZEMjUyRUE2OnNlY3JldA==
Complete Header line:
Authorization: Basic MDBEOERERkUtODZCRi00OTEzLUEzQTMtNEYxMkZEMjUyRUE2OnNlY3JldA==
1.2 Elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| ApiKey
| required
| guid
| E91F76F2-8E42-4B30-A4CF-A64A3D6D85CB
| -
| Api-Key to identify the API user
|
| ApiSecret
| required
| string
| secret
| -
| Api-Secret to authenticate the API user.
|
| Language
| optional
| string(2)
| EN
| EN
| Two letter ISO 639-1 Code of the Language to be used for all translated items.
|
| SystemOfMeasurement
| optional
| string
| Metric; Imperial
| Metric
| System of measurement to be used for dimensions and weights
|
| Currency
| optional
| string(3)
| EUR
| -
| Three letter ISO currency code to be used for all monetary values. See here.
|
| IsDebug
| optional
| boolean
| -
| false
| Indicates whether the API is working in debug mode.
|
| ProcessingTime
| optional
| long
| -
| -
| The time in ms it took to process the request.
|
1.3 Example
XML:
<Header>
<ApiKey>E91F76F2-8E42-4B30-A4CF-A64A3D6D85CB</ApiKey>
<ApiSecret>secret</ApiSecret>
<Language>EN</Language>
<SystemOfMeasurement>Imperial</SystemOfMeasurement>
<Currency>USD</Currency>
</Header>
JSON:
"Header": {
"ApiKey": "E91F76F2-8E42-4B30-A4CF-A64A3D6D85CB",
"ApiSecret": "secret",
"Language": "EN",
"Currency": "USD",
"SystemOfMeasurement": "Imperial"
}