About ACME APIs

ACME's powerful API layer allows our partners to access and expand the ACME Ticketing Platform in ways that work best for their venues and their customers. The ACME web, point-of-sale, and access control applications are built on the same REST-based APIs that we make available to our partners.

This document covers the basics of accessing and interacting with the ACME APIs and should be used as the basis for understanding how to integrate with our API layer.


TABLE OF CONTENTS


Security

ACME APIs are REST-based on the HTTP transport layer with JSON as the primary request and response format. Access to the ACME APIs is only allowed via HTTPS using TLS 1.2+ encryption


Authentication and Access Requirements

API access is tied to an ACME user and permissions are controlled via Groups, Roles, and Permissions in Back Office. Before requesting access to the APIs, please have your local system administrator create and configure a user for you. Once a user has been configured, you can access the ACME APIs using a temporary session or by requesting an API key.

Sessions

Sessions are temporary keys used to access the ACME APIs. Sessions are generally used for testing, one-time tasks, or to begin development while waiting on an API key to be assigned by ACME Product Support.

Note: Sessions should never be used to build production applications as they will expire and the application will no be able to access the ACME APIs.


Create a Session

GET v2/b2b/customer/session

Headers (Choose One Set)

Email User

Username-Only User

x-acme-email: diana@hoj.com
x-acme-password: H!pp0Lyt4

x-acme-user-name: dprince
x-acme-password: H!pp0Lyt4
x-acme-tenantId: 999


Sample Response

{
    "roles": [
        "user",
        "Superuser"
],

    "session": "7nkMkckXxTukVZtIWxUK",
    "expireMs": 1584123502541,
    "email": "diana@hoj.com",
    "userName": "dprince",
    "tenantId": 999,
    "firstName": "Diana",
    "lastName": “Prince",
    "id": 575,
    "confirmed": true,
    "onBoarded": true,
    "title": "Princess of Themyscira",
    "tenantTimeZone": "America/New_York",
    "companyName": "Golden Lasso Adventures"
}

The session ID returned in the session attribute can be passed into subsequent API calls using the x-acme-session header.

API Keys

For most integration projects, you’ll likely want to have an API key assigned to a user. This key allows you to skip the step of creating a session and is passed into calls using the x-acme-api-key header.  

WARNING: API keys should be kept secret just as you would a username and password. Anyone who has an API key will be able to access, via API, any area of the system for which the user has permission.

API keys can only be assigned to username-only users and we recommend creating a clearly-identifiable, integration-specific user for each integration. Examples would include:

  • api-website-integration

  • api-data-warehouse

  • api-crm-integration 

Note: Only ACME Clients can request API Keys. System integrators and third-party vendors should reach out to their venue contact to have them request a key.


Please see the Requesting an API Key for the checklist of steps.

Standard Headers

There are several standard headers used to connect to the ACME APIs. The table below outlines these headers, uses, and when they are required.

Header

Description

Example

x-acme-email

Standard user’s email address

x-acme-email: diana@email.hoj

x-acme-user-name

Username-only user’s username

x-acme-username: dprince

x-acme-tenantId

Tenant ID for a username-only user

x-acme-tenantId: 999

x-acme-password

User’s password

x-acme-password: H!pp0Lyt4

x-acme-session

Temporary session ID returned from the session call

x-acme-session: 7nkMkckXxTukVZtIWxUK

x-acme-api-key

ACME-assigned API key 

x-acme-api-key: a4c5cfd3-0783-4890-a6e1-e09eb9e11b4d

x-b2c-tenant-id

Tenant ID - required for all unauthenticated B2C calls

x-b2c-tenant-id: 999

x-acme-request-uuid

User-generated UUID used in checkout calls to avoid duplicate transactions

x-acme-request-uuid: 8270b929-44ea-46fc-b399-cfe6fa960f24

x-acme-pub-api-key

ACME-assigned publishable API key used for CORS checkout only

x-acme-pub-api-key: 596ba147-beeb-4d28-aa0a-ba3bc574aadb

Rate Limiting and Intrusion Prevention Systems

To help identify and prevent excessive or erroneous calls to the ACME APIs that could impact service, ACME may use rate limiting or intrusion prevention systems to monitor, throttle, or block suspicious API activity. These thresholds are configured as to minimize their impact on everyday API use.  

An HTTP status code of 429 would indicate that the rate limit has been exceeded and you should try your request later.