API endpoints
API documentation link for creating sessions and visitors:-
https://api-newdemo.expoplatform.com/apidocs/v2/swagger.html
API documentation link for creating exhibitor company profile and products:-
https://expoplatform.com/api/requests.html
API Collection:-
https://drive.google.com/file/d/1XsxHp4zeDYM_LrgLJezgGDDakJ7_kud8/view?usp=sharing
Sandbox does not work correctly so please test the API endpoints via Postman.
/api/v2/account/set
This endpoint is used to create and update Visitors and Team Members.
Required parameters when you create the first time any Visitor
event_id:-When you hover on the event before entering you get the event_id for the event. For example- 145
first_name:- First Name of the visitor
last_name:- Last Name of the visitor
email:- Email-id of the visitor which will be used to log in to the event.
A parameter whose value will be set by default if not passed at the time of creating a Visitor/Team Member.
status:- When the visitor is created for the first time if the status value is not passed the value is set as ACTIVE in the event.
Set status to INACTIVE when creating a person for the first time
Don't send status at all as a parameter when updating a record so as not to overwrite whatever status they have
In case if the organizer wants the status value to be something else other than ACTIVE, so at the time of creating a visitor via API, the organizer can pass the different value of status that is INACTIVE, ACTIVE, INVITED, UPLOADED, BLOCKED, BANNED, WAITING LIST, APPROVED depending on the requirement of the organizer.
Other Parameters that can be set for visitors are:-
photo | Account profile picture |
job_title | Job Title of the visitor. For eg Manager |
title | Title before the first name of the visitor. For eg Mr, Mrs, etc |
company_name | Name of the company of the visitor. For eg ExpoPlatform |
country | Country to which the visitor belongs |
city | City to which the visitor belongs |
nationality | Nationality of the visitor |
postcode | Postcode of the visitor |
tel | Tel (phone number) |
website | Website link of the visitor(add https://) |
birthdate | Date of Birth format?NOT WORKING |
organisation_name | Name of the organization |
matchmaking_message | About the visitor. |
organisation_id | It was being created for only one of our clients ISF these guys use their custom integration of importing accounts from organization IDs |
activity_categories[] | product category ids(Separated by a comma) To select the sub-category you can pass the sub-categories ids separated by a comma. The id’s which you pass either the parent or child category respect to that Id the category will be selected |
address | Location of the visitor |
password | Account password |
speaker | If Account is Speaker set true (set 'false' to detach speaker from the event |
moderator | If Account is Moderator set true (set 'false' to detach speaker from the event |
send_email | The corresponding set for this API will be triggered from the platform.(by default-->false) |
default_lang | Default notification language(pass the ISO code)(by default-->English) |
twitter_page | Account Twitter Page |
facebook_page | Account Facebook Page |
Instagram_page | Account Instagram Page |
linked_in page | Account Linked-In Page |
youtube_page | Account YouTube Page |
Custom fields | Process explained below |
How to pass multiple activity/interest ids at the same time for the interest and activity categories.
Separate the ids by a comma. for example
How to set custom fields.
The custom fields that can be set up in visitor registration forms are attached in the screenshot
below
Step-1 To set up the above fields via API, you get a unique Name* value for each field whenever you drag these fields. Attaching the screenshot below.
Step-2 Copy the Name* unique value and pass the corresponding values according to the fields. Attaching a screenshot for your reference.
NOTE:-
It is recommended not to change the Name* value
For the checkbox field to tick mark the checkbox pass value=1
To upload the file pass the file link selecting a file directly from the local storage of your pc will throw an error.
For the select to pass multiple values separate the value by the symbol ||
Step-3 You can check on editing the visitor profile the fields will be seen like this.
Step-4 How to pass the other value for the below fields.
Send the other value like this below:-
"10":"UAID1725"
"10_other":"Value"
How To link a Team Member to an exhibitor
Mandatory parameters for Team Member Creation: event_id, exhibitor_id and/or exhibitor_external_id, member_role
A Team Member is viewed by the System as a Participant who is attached to an Exhibitor.
To attach an account to an exhibitor, alongside your /api/v2/account/set request, make sure that you are sending the aforementioned mandatory parameters.
Do bear in mind that the name of the exhibitor in which participants are attached to, overwrites what is passed on the parameter company_name.
How to create sessions
How to create an exhibitor company profile
Status and its corresponding values
STATUS_INACTIVE = 0;
STATUS_ACTIVE = 1;
STATUS_INVITED = 2;
STATUS_UPLOADED = 3;
STATUS_BLOCKED = 4;
STATUS_BANNED = 5;
STATUS_WAITINGLIST = 6;
STATUS_APPROVED = 7