Difference between revisions of "XMLMC API Quickstart"
(XMLMC API Quickstart Guide) |
|||
| Line 5: | Line 5: | ||
|- valign="top" | |- valign="top" | ||
|style="width:73%"| | |style="width:73%"| | ||
| − | |||
__TOC__ | __TOC__ | ||
|style="width:5%"| | |style="width:5%"| | ||
| Line 12: | Line 11: | ||
== Related Articles == | == Related Articles == | ||
| + | :* [[FAQ:Hornbill_API%27s_%26_Webhooks|FAQ:Hornbill API's & Webhooks]] | ||
:* [[Essential Integrations]] | :* [[Essential Integrations]] | ||
:* [[Advanced Integrations]] | :* [[Advanced Integrations]] | ||
| Line 18: | Line 18: | ||
==Communication== | ==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%27s_%26_Webhooks|FAQ:Hornbill API's & Webhooks]]. | ||
| + | |||
===Transmission=== | ===Transmission=== | ||
| − | https, | + | 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 [[File:XMLMCAPI - Endpoint Admin Section.png|thumb|Endpoint obtained from Hornbill Administration]] or by looking at the response of <nowiki>https://files.hornbill.com/instances/<instance_name>/zoneinfo</nowiki> |
| + | |||
| + | ===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/|<nowiki>https://api.hornbill.com/xmlmc/</nowiki> API]). | ||
| − | === | + | ===Authorisation=== |
| − | header | + | 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. | ||
| + | <pre> | ||
| + | Content-Type: text/xmlmc | ||
| + | Authorization: ESP-APIKEY 74ec711dbebf4e8fb8d667c8c57393e1' | ||
| + | </pre> | ||
==Samples== | ==Samples== | ||
Revision as of 15:16, 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 74ec711dbebf4e8fb8d667c8c57393e1'