This section contains information to help you start using the API.
# What is an API?
An API (application programming interface) is a way for different pieces of software to talk to each other via the Internet, using standardised communication protocols. Applications (‘clients’) which consume APIs may be authored in any of the many available programming languages.
# What is the Visit API?
The Visit API exposes core Visit data to enable communication with external software components. Endpoints are available which expose information in both XML and JSON formats, they are interchangeable interfaces to the same underlying database.
# What is the API used for?
The goal of the API is to facilitate automated communication between third party systems or software and the Visit database. It focuses on creating, reading, updating, and deleting visitor and partner information.
Common uses of the Visit API include:
- Extracting registration data for use in third party applications, such as data warehouses, housing/booking systems, dynamic websites and accounting systems.
- Automated management of visitors' registration details, to enable either partial (‘invited’ registrants) or complete registrations from a third-party system.
- Replication of visitor registration details from Visit into a third-party system
- Automated creation and management of exhibitor details and accounts in Visit
- Replication of exhibitor details from Visit into a third-party system
# How to use the API?
In order to use the API you need to authorize all software calls with an authorization key. Keys are managed by users from Organisations who have the user account management role.
# API Keys
Access from homepage: Organisation > API > API keys
# Add an API key
- Select + Add
- Enter the API Key state: Active/Disabled
- Describe in the Comments field what it is used for
- Specify when it expires in the Expires after field
- Limit its use to specific location from Allowed IP Addresses
- Select the events you want to enable it for in Events
- Add the contact details of the person in charge of it
The Advanced API supports the following two integration types:
# Background task
A background task is a scheduled task which runs periodically in Visit. The call frequency is approximately every 9 minutes. This function would typically be used to automate the process of reading/writing data between Visit and an external process. The flow of information may be from Visit to the external system, from the external system to Visit or a combination of the two. For example, you might implement a background task which checks for new registrations in Visit and updates an external CRM system.
# Endpoint function
Adding an endpoint function generates an associated URL which enables it to be triggered by and external call. When creating the function, you will be prompted to supply a valid API key which is associated with it. In a similar way to background tasks, you are free to work with Visit’s API and external systems to meet the requirements of your integration. An example is where you wish to synchronise external registrations with data; the action of creating record calls the Endpoint. The endpoint function in this case contains the necessary logic to fetch the new data from the remote system and create the new record in Visit using our JSON API.
# Add function
- Select + Add
- Enter a Name
- Select a function from the dropdown list available
- You should provide a unique key to identify your function if you select Endpoint
- Select Save
The Statistics tabs shows you the number of API calls as per your set filters: type, from, until and resolution.
The API statistics can also be filtered by API keys.