Developer Kit API Overview

Overview 

The Cadmium|Eventscribe Developer Kit API allows an exhibitor to use a third-party lead retrieval software to scan an attendee’s badge QR code and pull the registrant’s contact data in real-time*. Access to the Developer Kit API must be contracted by the exhibitor. 

The Developer Kit API will output the following data from registration:

• First Name
• Last Name
• Pronouns
• Position
• Organization
• Email
• Phone
• Address
• City
• State
• Postal Code
• Country Code (ISO alpha-3)

*The Developer Kit API receives updated registration data on the 15-minute mark (:00, :15, :30, :45), so it may take up to 15 minutes to see a new registrant or updates made to an existing registrant’s profile information. 

Requirements 

The following is required to access the Developer Kit API: 

• Unique API Key per exhibitor per event - this will be provided to the exhibitor after they contract API access
• Internet to connect to the API - it is recommended the exhibitor contract dedicated, reliable internet for their booth
• Developer who understands how to write code to call a web service API via the internet - development work to connect to the API is executed by the third-party  

API Usage and Restrictions 

By contracting and accessing the Developer Kit API, the Customer and its third-party vendors agree to the Cadmium Terms and Conditions and Privacy Policy. 

API Key & Test Accounts 

Once access to the Developer Kit API has been contracted by the exhibitor, they will be provided a unique API Key and test accounts to send to their third-party developer. 

An API Key is unique per exhibitor per event. If a third-party supports multiple exhibitors per event, each exhibitor must contract API access, and the third-party must use a unique API Key for each connection. 

The third-party must develop and test the connection to the API prior to the event start date. It is expected the third-party build in ample time for development and testing in case support is needed.

Technical Instructions 

Simply submit the decoded QR code URL as the ‘payload’ query string parameter in the request body and the exhibitor's unique ‘x-api-key’ in the header. Note, the payload query string parameter must be URL encoded. Review the Swagger specification interface for further guidance.

A successful request will return a response body with the attendee fields noted above. An unsuccessful request will return a response body with one of the following error codes: 

• 400: Bad Request – This means there is something wrong with your request. Please update your code.
• 404: Not Found – This means the user was not found in the API.
  • This is most likely because the attendee recently registered and does not exist in the API yet. Please wait until the next 15-minute mark (:00, :15, :30, :45) and try again. 
  • Confirm the QR code is a badge/registrant QR code from this event and not from another source like a special event ticket. 
• 500: Internal Server Error – This means there’s an error with the API. Please wait a few minutes and try again. If the issue persists, reach out to Customer Support at the contact information listed below. 

If the response body does not match the registrant’s profile data, this is most likely because an update was made within the last 15 minutes. Please wait until the next 15-minute mark (:00, :15, :30, :45) and try again. 

Customer Support 

For general questions about the Developer Kit, please reach out to the event organizer.

For third-party technical support questions about implementing the API, please contact Eventscribe Integration Services at [email protected]. Please include “[Event Name] Developer Kit API” in the email subject and the exhibitor’s name and booth number in the email body. Support is available Monday – Friday, 8 am – 5 pm ET.