ACME Ticketing: Integration with Cuseum for Digital Membership Cards

Cuseum's integration with ACME Ticketing's API allows for seamless retrieval of membership data. This document provides a comprehensive guide on how to configure the integration, specifically focusing on obtaining the required API key and utilizing the relevant ACME API endpoints to access membership data.

Prerequisites

ACME API Key

To enable the integration between Cuseum and ACME, an API key is required. This API key is unique and must be generated by each ACME customer.

Steps to Generate the API Key

Visit the ACME Developer Portal.
Follow the steps outlined in the ACME documentation to request and generate your API key:
- Requesting an API Key
Provide the generated API key to Cuseum for integration purposes.

API Endpoints

Cuseum integrates with ACME to retrieve membership information. Below is the specific endpoint that is used in this integration:

List Memberships

Endpoint: GET /v2/b2b/memberships

Documentation: List Memberships API

Cuseum uses this endpoint to fetch membership details. The information returned includes various fields related to the membership, such as member name, membership level, email address, cardholder details, and expiration dates.

Example Response

Below is a sample JSON response from the List Memberships endpoint:

{
  "id": 7177585,
  "isGift": false,
  "category": "Family",
  "importId": "8-10000923",
  "updatedBy": 13139,
  "updatedOn": "2024-05-01T06:44:01-05:00",
  "categoryId": "662c1197de52d560440183f3",
  "offeringId": "e38b1df68af24ccfa6edaf5c6d11606e",
  "cardholders": [
    {
      "id": 23603529,
      "city": "Kansas City",
      "name": "John Doe",
      "email": "[email protected]",
      "state": "MO",
      "barcode": "8-10000921",
      "country": "United States",
      "zipCode": "64110",
      "cardType": "primary",
      "deceased": "no",
      "lastName": "Doe",
      "addressId": 41524501,
      "firstName": "John",
      "startDate": "2023-12-31T18:00:00-06:00",
      "cardStatus": "active",
      "customerId": 15472481,
      "phoneNumber": "(816) 111-1111",
      "primaryCard": "yes",
      "printStatus": "printed",
      "cardImportId": "29020002076",
      "membershipId": 7177585,
      "constituentId": "8-10012959",
      "ignoreUpdates": false,
      "expirationDate": "2025-06-30T23:59:59-05:00",
      "streetAddress1": "1111 East 11th Street",
      "solicitationCodes": "",
      "acmeCustomerNumber": "8-10016959",
      "constituentImportId": "8-10016959",
      "excludeCardOnMemberCreation": false
    }
  ],
  "lastVersion": true,
  "offeringName": "Annual",
  "membershipTypeId": 7591,
  "membershipCategory": "Family",
  "membershipStanding": "active",
  "auxiliaryMembership": false,
  "membershipStartDate": "2024-01-01T00:00:00-06:00",
  "acmeMembershipNumber": "8-10000923",
  "externalMembershipId": "8-10000923",
  "membershipJoinedDate": "2024-01-01T00:00:00-06:00",
  "membershipExpirationDate": "2025-06-30T23:59:59-05:00"
}

Data Filtering & Processing

Cuseum iterates through the list of memberships and filters out the inactive records, retaining only active memberships for further processing.

Additional Resources

For more information on other ACME API endpoints and workflows, refer to the complete API documentation:

ACME API Documentation

This document provides additional insights and detailed explanations on how to utilize various ACME API endpoints beyond the membership information.

For any further assistance or inquiries, please reach out to the Cuseum support team at [email protected]