Developer Kit API Troubleshooting Guide

Overview

This document offers the event organizer troubleshooting guidance for addressing common questions and issues related to the Eventscribe Developer Kit API. Please note that when an exhibitor contracts the Developer Kit API, they use their own software to scan attendee badges and capture leads during the event.

Scope of Support 

Exhibitors and their third-party developers are responsible for implementing and testing the Developer Kit API within their software before the event begins. If their third-party software is not functioning, our support is limited to verifying that the API is operating as expected and addressing basic questions about its functionality, as outlined in this document. 

Functionality 

The Developer Kit API operates as follows: 

1. A third-party software scans the Eventscribe QR code on an attendee’s badge.
2. The software extracts the QR code URL and sends a request to the API.
3. If the profile information exists in registration, the API returns the following data:
   • First Name
   • Last Name
   • Pronouns
   • Position
   • Organization
   • Email
   • Phone
   • Address
   • City
   • State
   • Postal Code
   • Country Code (ISO alpha-3) 

Troubleshooting & FAQ

Review the information below to address common questions and potential issues that may arise during the event.

• Connectivity 
  • Verify the device is connected to the internet. 
    • Internet connectivity is required for the API connection to function. 
    • You can confirm this by asking the user to demonstrate loading a webpage. 
    • While the API response time is generally fast, it may vary slightly depending on the internet speed.
    • Note: The first scan may take longer to receive a response because the API needs to "warm up" after prolonged inactivity. 
  • Verify that the API is functioning by following the steps below:
    1. Go to the Swagger interface.
    2. Click 'Authorize' and enter an API Key for the event.
    3. Click 'Get' and then 'Try it out'.
    4. Enter an attendee's Eventscribe QR code URL for the event in the 'Payload' field.
    5. If profile data is returned for the attendee, the API Is working.
• Trouble Scanning QR Code 
  • Ensure that the QR code being scanned is the Eventscribe QR code on the attendee’s badge and not another source (e.g., a special event ticket or a link to the conference agenda).
• Discrepancies in Profile Data
  • To resolve profile discrepancies, follow these steps: 
    1. Verify Profile Information: Check the attendee's profile in both the registration and website/mobile app modules to identify the source of the discrepancy. 
    2. Update Registration Profile: Update the registration profile (the source of truth). Changes will sync automatically to the website/mobile app profile. 
    3. Confirm Changes: Ensure the profile updates are reflected in the website/mobile app module. 
    4. Wait for API Sync: Wait for the next 15-minute increment (:00, :15, :30, :45) for changes to sync to the Developer Kit API. 
    5. Rescan QR Code: Scan the attendee's badge again to pull the latest data from the API. 
  • Note: Third-party software may handle repeat scans differently and might not reflect updates to previously scanned profiles. To confirm the API is working and reflects the changes, follow the steps outlined under the "Connectivity" section above, using the Eventscribe QR Code URL for the specific attendee.

API Error Codes 

The following section provides detailed explanations of the error codes that may be returned by the API.

• 400: Bad Request 
  • Cause: The API request is incorrectly formatted.
  • Solution: The third-party developer must update their code to ensure the request meets API requirements.
• 403: Forbidden
  • Cause: The API Key is incorrect for this event.
  • Solution: Verify the API Key being used is correct. 
• 404: Not Found 
  • Cause: The attendee’s information is not found in the API.
  • Solution: Confirm the attendee did not register within the last 15 minutes. The API updates registration data every 15 minutes (:00, :15, :30, :45), so it may take up to 15 minutes for new registration data to appear.
• 500: Internal Server Error
  • Cause: There is an issue with the API itself.
  • Solution: Wait a few minutes and try again. If the issue persists, contact Cadmium Customer Support.

Customer Support

If you encounter issues that cannot be resolved using this guide, please reach out to Cadmium Customer Support, as you normally would, for assistance. Please include the following details in your support request:

• Exhibitor Name
• Booth #
• Error message received
• Detailed description of the issue and steps to reproduce it
• Results of all the troubleshooting steps listed above