Skip to main content
Version: 1.0

REST APIs

Platform Features

Applications​

Application Management​

Available Operations:

  • Get all applications: Retrieve all applications for the authenticated organization
  • Get application: Retrieve a specific application by its ID (public endpoint)
  • Create application: Create a new application for the authenticated organization
  • Update application: Update an existing application for the authenticated organization
  • Delete application: Delete an existing application for the authenticated organization

Accounts​

Customer Account Management​

Available Operations:

  • Get accounts: Retrieve all customer accounts associated with a specific application for the organization

Digital Product Passport​

DPP Minting Operations​

Available Operations:

  • Mint DPPs: Create digital product passports in batch using JSON Lines format
  • DPP Mint status: Get the current status of a minting job
  • Stream DPP minting progress: Real-time progress updates via Server-Sent Events (SSE)

Loyalty​

Loyalty Program Management​

Available Operations:

  • Get loyalty settings: Retrieve loyalty program configuration for an application
  • Create loyalty settings: Set up a new loyalty program for an application
  • Update loyalty settings: Modify existing loyalty program configuration

Loyalty Points of Sale Administration​

Available Operations:

  • Get all points of sale: Retrieve all loyalty points of sale for the authenticated organization
  • Get point of sale: Retrieve a specific loyalty point of sale by its ID
  • Create point of sale: Create a new loyalty point of sale for the authenticated organization
  • Update point of sale: Update an existing loyalty point of sale (partial updates supported)
  • Delete point of sale: Delete an existing loyalty point of sale from the organization

Zelty​

Zelty Integration Management​

Available Operations:

  • Get settings: Fetch current Zelty integration settings for your organization
  • Create settings: Create new Zelty integration configuration
  • Update settings: Update existing Zelty integration settings
  • List restaurants: Get all Zelty restaurants associated with your organization
  • Update restaurant: Assign or update application links for specific restaurants

Authentication​

Your API key

Security Scheme Type:

apiKey

Header parameter name:

X-Api-Key