ASP Integration

ASP Platform is used by our client to host various elements of event management which are important for an Event.

The current version of the ASP’s Integration with Expoplatfrom is built on the basis of the below ASP documentation.

Documentation Link:- https://api.showoff.asp.events/public/

Details required from ASP end to enable the integration are as follow:-

API Key = Api key
API PW = Secret
Site UUID = Site UUID

To enable the integration navigate to Event Setup → General → Settings Tab → ASP. You should land on the below setting.

In the abovementioned placeholder please input the respective values viz API key, Secret, and Site UUID and then save the settings.

Once the setting is saved the below 2 additional settings would appear under the ASP Integration.

Setting to choose which elements should be pulled

Subscribe for creation:- If this checkbox is enabled then the integration will only create the new record and not pull updates to the existing exhibitor/session records in that particular event.

Subscribe for updates:-If this checkbox is enabled then the integration will also pull updates to the existing exhibitor/session records in that particular event.

Additional settings for Exhibitor data sync

Default Hall:- If the hall information is not available on ASP and only stand information is available then the Admin can choose to bring all the exhibitor stands under a single hall and its name can be updated in the text box provided for the Default Hall.

Send Team Member email:- Once this setting is enabled it sends out an email to every new team member that is pulled into EP via ASP integration under the exhibitor's contacts.

Assign this category to Admin:- This functionality allows the Admin to assign a custom participant category to the Main Contact on the ASP end for the respective Exhibitor.

Assign this category to members:- This functionality allows the Admin to assign a custom participant category to the other contact on the ASP end for the respective Exhibitor.

Once all the required settings are updated, save the settings by clicking on the save button at the end of the page.

To start pulling the data click on the Sync/Resync button to under the respective element and save the settings at the bottom of the page.

The current scope of the integration allows EP to pull the following elements from the ASP system to EP.

Exhibitor
Sessions + Speakers (attached to the particular session)

Exhibitor Data sync:-

The exhibitors are pulled from ASP using the GET /exhibitors and GET /exhibitors/{siteuuid} endpoints.

Field mapping for the exhibitor data is as below.

Respective EP API Field	Name	Type	Desc
external_id	Uuid	uuid	Exhibitor UUID
name	Name	string
N/A	Slug	string	Partial URL for the Exhibitor's page.
N/A	Url	string	Full URL to the Exhibitor's page.
N/A	Code	string	Unique identifier for Client use.
N/A	AccountNumber	string
about	Description	string	Description of the Exhibitor.
logo	Logo	string	URL pointing at Exhibitor's logo.
website	Website	string	URL of the Exhibitor's website.
email	Email	string	Email for the Exhibitor.
Should be true	isPublished	boolean	Whether the Exhibitor's page is active or draft mode.
N/A	PublishDate	datetime	The Exhibitor's page is not active before this date.
N/A	ExpiryDate	datetime	The Exhibitor's page is not active after this date.
Should be true	isActive	boolean	Whether the Exhibitor's page is published and not expired.
Registration date	CreationDate	datetime
last modified date	ModifiedDate	datetime
N/A	Site	sub-resource	Site the Exhibitor's content belongs to.
address	Address	sub-resource	Physical/postal address.
country	Country	sub-resource	Primary Country of the Exhibitor.
N/A	Featured	boolean	Whether the Exhibitor's page is featured
is_sponsor	Sponsored	boolean	Whether the Exhibitor's page is sponsored
is_new	New	boolean	Whether the Exhibitor's page is new
facebook,linkedin,twitter,instagram, youtube	Social	sub-resource	Social network profiles of the Exhibitor.
Team Members	Contacts	collection	Contacts (people) assigned to the Exhibitor
cp_name cp_surname	Name	string	Name of the Contact
cp_position	JobTitle	string
Not pulled	Username	string	Username for Ezone
profile image	ProfileImg	string	Request URL of the profile image
cp_email	PrimaryEmail	string	The Contact's primary email address.
cp_phone	PrimaryPhone	string	The Contact's primary phone number.
extenal_id (accounts)	ClientReference	string	Unique identifier for Client use.
is Admin ?	isMainContact	boolean	True when Contact is marked as main for the Exhibitor.
stand	Stand
stand	Name	string	Stand Name
hall	Hall	string	Hall Name

Points to note for Exhibitor Data:-

Exhibitor for the isActive+isPublished parameter is true are only synced from ASP to EP.
The exhibitor category cannot be synced
For Product categories, the client needs to first configure all the product categories on Expoplatform’s end and generate their respective ID’s via from Expoplatfrom System. Then update the same IDs for the product categories on the ASP end. This step needs to be done before the sync is enabled.
For records with the missing email address, the MainContact’s email address will be used as the exhibitor’s email address.
If MainContact is “true' then the record is added as an Admin Team Member in EP, if not then as a regular member in EP
If the Default Hall value is not configured in settings and we received from ASP empty Hall -> this stand is skipped, so the exhibitor will be synced without this stand.

2. Sessions + Speakers (attached to the particular session) data sync:-

For sessions data the GET /sessions and GET /sessions/{siteuuid} would be used and for speakers: GET /sites/{siteuuid}/speakers and GET /sites/SiteUuid/speakers/Uuid endpoints will be used.

Field mapping for Sessions data is as follows:-

Respective EP fields	Name	Type	Desc
	Uuid	uuid	Session UUID
	Slug	string	Partial URL for the Session's page.
	Url	string	Full URL to the Session's page.
	Code	string	Unique identifier for Client use.
Should be true	isPublished	boolean	Whether the Session is active or draft mode.
	PublishDate	datetime	The Session is not active before this date.
	ExpiryDate	datetime	The Session is not active after this date.
Should be true	isActive	boolean	Whether the Session is published and not expired.
	CreationDate	datetime
last modified	ModifiedDate	datetime
	Site	sub-resource	Site the Session belongs to.
	Seminar	sub-resource	Seminar the Session belongs to.
description	Description	string	HTML description of the Session
	Abstract	string	HTML abstract of the Session
	Type	string	Type of the Session, e.g. "Session","Break","Lunch".
date + endTime	StartDate	datetime	When the session starts (UTC datetime).
date + startTime	EndDate	datetime	When the session ends (UTC datetime).
	LocalDate	string	The session date, (local show time).
	LocalStartTime	string	The session start time, (local show time).
	LocalEndTime	string	The session end time, (local show time).
Speaker	Speakers	collection	The Speakers for the Session.
track	Location	sub-resource	The Stand location of the Session.
tags	Stream	collection	Streams assigned to this Session.
	Categories	collection	Categories assigned to this Session.
isFeatured	Featured	boolean	Whether the Session is featured
	Sponsored	boolean	Whether the Session is sponsored
	New	boolean	Whether the Session is new

Field mapping for Speakers data is as follows:-

Respective EP Fields	Name	Type	Desc
	Uuid	uuid	Content UUID
	alt	link	Struct containing URL of the Speaker's non-Site-specific resource.
description	Description	string	HTML description of the Speaker
	Slug	string	Partial URL for the Speaker's page.
	Url	string	Full URL to the Speaker's page.
	Code	string	Client-provided unique code for the speaker
Should be true	isPublished	boolean	Whether the Speaker is active or draft mode.
	PublishDate	datetime	The Speaker is not active before this date.
	ExpiryDate	datetime	The Speaker is not active after this date.
Should be true	isActive	boolean	Whether the Speaker is published and not expired.
	CreationDate	datetime
last modified date	ModifiedDate	datetime
	FieldData	struct	A name:value struct (map) of Speaker custom field data
	Name	string	Full Name of the Speaker
first_name	Firstname	string	Firstname of the Speaker
last_name	Lastname	string	Lastname of the Speaker
	Code	string	Client-provided unique code for the speaker
job_title	JobTitle	string
photo	ProfileImg	string	Request URL of the profile image
company_name	Company	sub-resource	Company the visitor is associated with.
	Event	sub-resource	The Event (Product) the person is speaking at.
email	PrimaryEmail	string	The Speaker's primary email address.
phone	PrimaryPhone	string	The Speaker's primary phone number.
N/A	Emails	collection	Email addresses.
N/A	Phones	collection	Phone numbers.
facebook,twitter,instagram, youtube,linkedin	SocialProfiles	collection	Social Network profiles.
address	Addresses	collection	Physical/postal addresses.
N/A	Featured	boolean	Whether the Speaker's page is featured
N/A	Sponsored	boolean	Whether the Speaker's page is sponsored
N/A	New	boolean	Whether the Speaker's page is new
is_speaker	Yes