Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Overview

This article goes through purchasing a developer kit from an exhibitor portal, setting up a Captello capture form for lead scanning using the purchased developer kit, and using the developer kit with 3rd party software.

Purchasing a Developer Kit and Acquiring Credentials

To purchase a developer kit from an exhibitor portal, follow the steps below:

  • Navigate to the ‘New Order’ page.

image-20240612-184830.png
  • Add the ‘Developer Kit’ service to the cart.

image-20240612-185041.png
  • Proceed to checkout and place your order.

image-20240612-185342.png

Acquiring Credentials

  • Once the order is successful, navigate to the ‘My Services’ page.

image-20240612-185524.png
  • Click on the developer kit’s details hyperlink.

image-20240612-185623.png
  • You will be presented with your credentials.

image-20240715-114727.png

Setting up a Captello Capture Form for Lead Scanning

For information about creating a capture form, refer to https://leadliaison.atlassian.net/wiki/spaces/LL/pages/18931801/Lead+Capture+Management#Creating-an-Event.

To set up lead scanning with the dev-kit credentials on your capture form, follow the steps below:

  • Access the scanner element properties.

image-20240612-190333.png
  • From the ‘Scan provider’ drop-down, select ‘Captello Exhibitor Shared’.

image-20240612-190440.png
  • Add your credentials to the ‘Token’ and ‘Environment’ fields.

image-20240612-190611.png
  • Save the form.

Your capture form is now ready to scan badges from the Exhibitor Portal event!

Using Third Party Lead Scanning Software

Using a 3rd party software with the developer kit requires additional development from the 3rd party’s end using the following API documentation.

API Documentation

The token acquired earlier is to be used as an API key.

GET URLs

Depending on your environment (shown in your developer kit details), use one of the following URLs.

image-20240715-114621.png

Production:

https://api.leadliaison.com/v1.0/badge-scan.json?token={token}&barcodeId={badgeID}

Europe:

https://eu-api.leadliaison.com/v1.0/badge-scan.json?token={token}&barcodeId={badgeID}

Responses

Invalid Token

{
    "success": 0,
    "message: "Exhibitor portal not found"
}

Invalid badge ID

The response may change based on the badge provider used by the Exhibitor Portal organizer).

 Example:

{
    "success": 0,
    "message: "Exhibitor portal not found"
    "additionalInfo": []
}

Valid Badge ID

{
  "success": 1,
  "info": [
    {
      "ll_field_id": 9,
      "ll_field_unique_identifier": "WorkPhone",
      "value": "111-111-111"
    },
    {
      "ll_field_id": 10,
      "ll_field_unique_identifier": "MobilePhone",
      "value": "(111) 1111-1111"
    },
    {
      "ll_field_id": 16,
      "ll_field_unique_identifier": "FirstName",
      "value": "test"
    },
    {
      "ll_field_id": 17,
      "ll_field_unique_identifier": "LastName",
      "value": "test"
    },
    {
      "ll_field_id": 21,
      "ll_field_unique_identifier": "Email",
      "value": "test@test.com"
    },
    {
      "ll_field_id": 22,
      "ll_field_unique_identifier": "Company",
      "value": "test"
    },
    {
      "ll_field_id": 24,
      "ll_field_unique_identifier": "Website",
      "value": "www.test.com"
    },
    {
      "ll_field_id": 26,
      "ll_field_unique_identifier": "Country",
      "value": "USA"
    },
    {
      "ll_field_id": 27,
      "ll_field_unique_identifier": "City",
      "value": "test"
    },
    {
      "ll_field_id": 28,
      "ll_field_unique_identifier": "State",
      "value": "test"
    },
    {
      "ll_field_id": 29,
      "ll_field_unique_identifier": "StreetAddress",
      "value": "test"
    },
    {
      "ll_field_id": 30,
      "ll_field_unique_identifier": "FullAddress",
      "value": "test"
    },
    {
      "ll_field_id": 31,
      "ll_field_unique_identifier": "Zipcode",
      "value": "1111"
    }
  ],
  "additionalInfo": {
    "action": "default",
    "is_duplicate": false,
    "is_pending": false
  }
}

Response if the form does not have a scanner element:

{
    "success": 0,
    "message: "Invalid form"
}
  • No labels