REST API integration recipe - customer portal

Use case

This pattern consists in using a third party (customer) portal in order to authenticate end-users and allow them to access SpotMe events.

This is a powerful integration pattern because it not only allows the registrant to easily register to an event, but it also generates a unique link (or magic link) for the registrant to directly access the SpotMe platform when the event time comes.

Integration prerequisites

The customer portal will need to know the list of SpotMe events to display (via the event EIDs).

This can be done manually/statically via the portal’s CMS or via the SpotMe API integration to dynamically obtain all relevant active SpotMe events as described in this pattern.

Pattern steps

See below a breakdown of the steps involved in the pattern.

STEP 1 - Registrant logs in to the customer portal

Registrant logs and is authenticated by the customer portal.

STEP 2 - (Optional) Dynamically list the upcoming events

When building the list of upcoming SpotMe events dynamically, the API consumer should use the
GET /orgs/{orgid}/workspaces API endpoint to retrieve the relevant events under a particular SpotMe organization.

Data fields such as "start date", "is active" flag, and "category" should be used to filter and order the results.

STEP 3 - Create a SpotMe "person" record

By using the customer portal profile data of the registrant and the event ID (EID) of the event selected by the registrant in the previous step, the API consumer should use the
POST /workspace/{eid}/global/docs/person API endpoint to create the corresponding "person" record in SpotMe.

The registrant’s unique event invitation link (or magic link) will be returned to the portal.

STEP 4 - (Optional) Store the customer portal's record ID

Am email can be sent from the SpotMe platform or from the customer portal (or any other platform integrated with it) and contain the associated unique event invitation link (or magic link).

STEP 5 - (Optional) Send “Invitation to join” email

For each event that a logged in user has registered to, the customer portal will receive an associated unique invitation link (or magic link) on step 3.

The user should be able to click this link from the customer portal to automatically be directed and authenticated into the SpotMe app.