Difference between revisions of "XMLMC API Quickstart"
(XMLMC API Quickstart Guide) |
m (→Authorisation) |
||
| Line 33: | Line 33: | ||
<pre> | <pre> | ||
Content-Type: text/xmlmc | Content-Type: text/xmlmc | ||
| − | Authorization: ESP-APIKEY | + | Authorization: ESP-APIKEY ###32 hexadecimal characters#### |
</pre> | </pre> | ||
Revision as of 15:42, 18 August 2021
Home > Integration > XMLMC API Quickstart Guide
Related Articles |
Communication
One needs to POST a payload to a https endpoint with the HTTP headers containing the Authorisation. One can read up on other technical considerations in the FAQ:Hornbill API's & Webhooks.
Transmission
Data has to be sent over https (port: 443) to a given endpoint. One can find the endpoint base for your particular instance by either viewing the About-section in Hornbill Administration
or by looking at the response of https://files.hornbill.com/instances/<instance_name>/zoneinfo
Documentation
The endpoint base obtained, with the addition of "/xmlmc/" will lead to the documentation on what methods are available (https://api.hornbill.com/xmlmc/ API).
Authorisation
The HTTP-header will need to contain the API Key which must be generated in the user's profile within the Hornbill Administration. The header we use for this, is going to be Authorization with a ESP-APIKEY prefix. The default payload is expected to be XMLMC, so we will set the Content-Type accordingly.
Content-Type: text/xmlmc Authorization: ESP-APIKEY ###32 hexadecimal characters####