API Connection & SSO

3. CREATE EXHIBITORS

Both update/create exhibitors use the same cloud function endpoint:

https://us-central1-ffair-live.cloudfunctions.net/endpointsSSO-createExhibitors

Create/Update Exhibitor request example:

Note: companyName, standName, contactEmail fields cannot be changed.

Note2: exhibitorId should be used when creating a new Exhibitor.

{
   "data":{
      "showId":"",
      "exhibitors":[
         {
            // external exhibitor id
            "exhibitorId":"12345", // string (required *, use this when creating a new Exhibitor)
            "internalId":"12345", // string (required *, automatically generated, can be found in the resposnse body, when creting a new Exhibior, cannot be used when creating a new Exhibitor)
            // * -- only 1 of 2 must be in (xor operation)
            "companyName":"First Company", // string (required)
            "contactName":"Mark Strong", // string (required)
            "contactEmail":"mark.strong@mailinator.com", // string (required)
            "buildType":"build 1", // string (required)
            "standNumber":"G34", // string (required)
            "contactNumber":"343-43-35", // string (optional)
            "companyAddress":"London, UK", // string (optional)
            "companyPostcode":"343 KO9", // string (optional)
            "isPrimary":true, // string (optional)
            "standWidth":10, // float number (optional)
            "standLength":12, // float number (optional)
            "irregularArea":100, // float number (optional)
            "openSides":30, // number (optional)
            "standWallLength":13, // number (optional)
            "contractorCompanyName":"Event Tech", // string (optional)
            // to load packages, it must exists on the show
            // package name must be one of the show package names
            "packages":[
               {
                  "name":"Package 1", // string (required)
                  "quantity":3 // number (required)
               },
               {
                  "name":"Package 2",
                  "quantity":4 (number)
               }
            ],  // array (optional)
            // to load custom fields, it must exists on the show
            // custom field id you can find in exhibitors template (Show Exhibitors->Bulk Upload -> Downdload Template)
            // custom field value for all types should be string;
            // custom field file type value should be base64 file string; 
            // custom field file type supported extensions .doc,.docx,.pdf,.jpg,.jpeg,.png,.gif,.eps,.bmp,.xlsx;
            // custom field file type maximum size is 5mb
            "customFields":[
               {
                  "id":"jqWDUfXDA85b1gD6VhhS", // string (required)
                  "value":"123" // string (required)
               },
               {
                  "id":"FuwG0wI5511K7dYxQE5o", // string (required)
                  "value":"some text" // string (required)
               }
            ] // array (optional)
         }
      ]
   }
}

Note: Multiple files can be uploaded to the same File Upload custom field on a single Stand via the createExhibitors API.
To achieve this, multiple objects with the same custom field ID must be included in the customFields array, e.g.:

"customFields": [
    {
        "id": "customFieldId",
        "value": "validFile1ConvertedToBase64String"
    },
    {
        "id": "customFieldId",
        "value": "validFile2ConvertedToBase64String"
    },
    {
        "id": "customFieldId",
        "value": "validFile3ConvertedToBase64String"
    }
]

Note 2: If a file is uploaded to a File Upload custom field via the createExhibitors API and the custom field already contains previously added files, the new file should be appended to the field. Existing files must not be replaced; they should remain.

Response Example:

{
    "return": {
        "exhibitors": [
            {
                "email": "test_api@mail.com",
                "id": "BGoziHInalNh4HW0qKoa55DWyGk2",
                "externalExhibitorId": "F112asjhkas911311",
                "inviteLink": "https://app.ffair.io/sign-up/exhibitor?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaG93SWQiOiJkaGJHcElicjU1NDhHZENpc0t3dCIsImV4aGliaXRvclBhaXJJZCI6ImJjMzk1Mjc5LTFlYTEtNDZiOC1iOWMzLTg5Y2U4NjM1NWMwMyIsImV4aGliaXRvclVzZXJDb25uZWN0aW9uSWQiOiI5M2M1YTEyNi00MjRmLTRlNDctYTc1OC03MjQ3NjNmMTI3YjgiLCJpYXQiOjE3Njg1Nzk4MjksImV4cCI6MTkyNjM2NzgyOX0.6MzWsFA0kbcUUTtD9J2sQUFJi_yerrppjK61zMm4xTk"
            }
        ]
    }
}

GET EXHIBITORS

https://us-central1-ffair-live.cloudfunctions.net/endpointsSSO-getExhibitors

Return Exhibitor Data Type:

type ExhibitorStatus = "notInvited"|"pending"|"active"|"archived"|"blocked;

export type GetPackageResponse = {
  id: string;
  name: string;
  quantity: number;
};

export type GetCustomFieldResponse = {
  id: string;
  title: string;
  type:  "text" | "hyperlink" | "number" | "fileUpload" | "paragraph";
  value: string[] | string | number | null;
  name?: string | null; // only for "hyperlink" type
};

export type GetExhibitorResponse = {
  id: string;
  externalId: string | null;
  lastName: string;
  firstName: string;
  email: string;
  inviteLink: string;
  contactNumber: string | null;
  status: ExhibitorStatus;
  company: {
    id: string;
    createdAt: string;
    address: string | null;
    name: string;
    postcode: string | null;
    webAddress: string | null;
    keyContractor: string | null;
  };
  stand: {
    id: string;
    createdAt: string;
    name: string;
    openSides: number | null;
    primaryId: string | null;
    invitationDate: string | null;
    size: { area: string; width: string; length: string } | null;
    wallLength: number | null;
    packages: GetPackageResponse[];
    buildType: {
      id: string;
      name: string;
    };
    customFields: GetCustomFieldResponse[]
  };

};