ExpoPlatform Public API Version 2.0 Documentation

Overview

Using this API, you can receive the following information:

• Visitor Information;
• Exhibitor Information;
• Event Categories;
• Event Information;
• Speakers Information;
• All static information pages.

The ExpoPlatform Public API is a web based API that allows direct access to data stored within the platform and is shipped as part of the web frontend. It uses the JSON protocol which means two things:

• The API consists of a set of separate methods;
• Responses from API are encoded using the JSON format.

More information about the protocol and JSON can be found in the JSON-RPC 2.0 specification and the JSON format homepage.

Structure

The API built on the CRUD (create\update\delete) scheme. Each of the methods performs one specific task. For example, the create method belongs to the host API and is used to create new data in local DB.

Main URL

Once the frontend is set up, remote HTTP requests can be used to call the API. The API can be queried by sending HTTP requests to the platfrom backend:

https://{{ CLIENT }}.expoplatform.com/

Authorization

To protect user data, the API uses basic access authentication. In order to access any data inside of platform through the API you will need to insert your API KEY in the header section.

Header Example:

Authorization: Basic tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc

If authentication is successful, the API will return information in the structure described in the following sections

Profile Sign-In

To log into profile send POST request to

https://{{ CLIENT }}.expoplatform.com/oauth/authorize?api=true&redirect_uri=token&response_type=code

POST

with data:

username	Your username in platform
password	Your password in platform
eid	Event ID (integer)

Optional paramets to receive admin access token. You will need to pass admin username and password in this case:

appcheckin

true

Response example:

{
  "token": "cd1340e032ab057d0a79f1565d0eb9e0",
  "id": "1752"
}

Error codes and description

Error code	Description
400	Bad Request
401	Unauthorized

CheckIn Sign-In

In order to access the check-in API an authentication using admin credetials should be done at the following URL:

https://{{ CLIENT }}.expoplatform.com/oauth/authorize?api=true&redirect_uri=token&response_type=code&appcheckin=true

POST

with data:

username	Your admin username
password	Your admin password

Response example:

{
  "token": "cd1340e032ab057d0a79f1565d0eb9e0",
  "id": "1752"
}

Error codes and description

Error code	Description
400	Bad Request
401	Unauthorized