The Evessio API
In this article
Generating your API Token
API Tokens
In order to use the API, tokens are required. Only Evessio can create new tokens. Please contact Evessio support if you require a new token or additional tokens. support@evessio.com
Getting your API token
Click your name in the top right corner and then go to Events HQ.
Click Settings > API > API Tokens
Once your token has been added by Evessio support, you can click the copy to clipboard button.
Authorising the API Docs
Next click the the API Docs and press Authorize on the right of the page.
Paste the token into the value field and click Authorize
How to log out of a browser session
You can return to the API Docs section, click Authorize and then logout.
Available API Endpoints
Event List endpoints;
| Event List Endpoints |
| Events |
| Event uuid |
Per Event endpoints;
| Event Users endpoints | Organisations endpoints | Schedule endpoints | Customers endpoints | Transactions endpoints |
| Users | Exhibitors | Locations | Event Attendance | Orders |
| User uuid | Exhibitor uuid | Sessions | Awards Nomination | Transactions |
|
|
|
|
Table Booking | Transaction uuid |
|
|
|
|
Custom Product |
|
|
|
|
|
|
|
Testing an API Request
To make an API call you can click your name in the top right corner and then go to Events HQ.
Click Settings > API > API Docs
Find the endpoint you would like to use in the list and click the arrow to expand the section.
Click Try it out
Enter any queries if applicable
Click Execute
You can then read the responses further down the page. You will have the ability to download the response as a .json file.
Retrieving data for a specific event
When using a per event endpoint the event uuid string is a required parameter.
You can pull the event uuid from the Events endpoint or take it from your address bar when inside your events admin portal.
or
Once you have the event uuid paste it into the event_uuid string field.
There may also be other parameters which you can fill out depending on the endpoint.
Once complete click Execute to receive the data.
Making requests from external systems
- The Evessio API requires that the authorization token be present in the header of all requests
- The header must contain the Evessio-Key:
- An example of how requests can be made is provided in the responses section titled Curl
curl -X GET "https://admin.evessio.com/api/v1/public/events/[EVENT-UUID-HERE]/transactions?date-period-type=till-now" -H "accept: application/json" -H "Evessio-Key: [YOUR-API-TOKEN-HERE]"