quick-start.md

Quick Start

Get up and running in no time.

The API is made to be easy to understand and authenticate with.

Set up

To communicate with the API you'll need to know the BASE URI and an API token. These can be found under System -> API Tokens.

• Make sure all requests use the BASE URI before the endpoints.
• Within your request make sure to set the Authorization header with your API Token.

Communicating with the API

Get all categories

curl -i \
    -H "Accept: application/json" \
    -H "Authorization: <TOKEN>" \
    <BASE_URI>/categories

Get the details of a specific category

curl -i \
    -H "Accept: application/json" \
    -H "Authorization: <TOKEN>" \
    <BASE_URI>/categories/<ID>

Create an enquiry

curl -i \
    -H "Accept: application/json" \
    -H "Authorization: <TOKEN>" \
    --data "<DATA>" \
    <BASE_URI>/enquiries

It's that simple!