TABLE OF CONTENTS
- About ACME API’s
- Online Checkout
- Scenarios & Endpoints
- Using the B2C APIs
About ACME API’s
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.
One of the first integrations ACME partners take on is a custom eCommerce solution that lets you control the entire purchasing experience and have a seamless checkout for your customers, from their first clicks on your site to the final purchase. The ACME APIs make it easy to fully integrate the ticket purchase flow into your existing website using a few simple calls.
Online Checkout is the process by which a customer goes through to purchase items on an online store/platform. The customer may checkout immediately, or choose to save items to their cart while pondering choices and checkout at a later time. The ACME Shopping Cart facilitates both the immediate and delayed checkout approach.
In contrast, Kiosk Checkout is always immediate. The customer is present on site and will either complete their purchase or cancel the order and walk away. Of course the former is always preferred!
Online checkout can either be Server based or Browser based.
- Server Based: Server to server implementation. PCI is in scope for this approach.
- Browser Based: Browser checkout via CORS. The advantage to this is descoped PCI.
Scenarios & Endpoints
Get a list of items available for sale
Events with Tickets & Add-ons
Various endpoints are available to help you to get information regarding events and their availability for purchase.
See Event & Calendar APIs (B2C)
See Memberships API folder for res
Manage a Shopping Cart
Include the items you want to sell, such as tickets or donations, and add them to the shopping cart
- Create a new Shopping Cart
- Get a Shopping Cart
- Update a Shopping Cart
- Delete a Shopping Cart
You can also specify discounts on tickets, via coupon codes or member discounts.
See Discounted Ticket Sales (via Coupon or Member) for examples.
Once you are ready, you can complete the purchase trough checkout process
- Checkout with a Shopping Cart ID
- Checkout with a Shopping Cart Object & Items
Get order details
Using this endpoint you will be able to get the details of your purchase like event information, payment amount and billing information.
- List / Search Orders
- List orders for an Event
- Get an Order
- Update an Order
- Delete an Order
See B2C Orders
Using the B2C APIs
These parameters are used in all of the B2C endpoints.
Tenant ID for the owner of the event templates you are looking for.
If you do not yet have one, request an API key. This key must be securely passed into calls using the x-acme-api-key header.
x-acme-browser-ip: (Required for checkout, Optional otherwise)
Acme integration projects uses IP addresses to prevent unauthorized activity across endpoints