Skip to main content
Version: 1.0

REST APIs

Tokenized Product Passport APIs​

The TPP APIs enables you to manage the complete lifecycle of Tokenized Product Passports. Whether you need to create, monitor, or receive real-time updates, this API provides a secure, high-performance gateway to integrate tokenization into your systems.

Key Features​

  • Job Creation: Initiate tokenization jobs by submitting a payload in JSON Lines format. Each line is a separate JSON object representing a product to be tokenized.

  • Job Status Monitoring: Query the status of your tokenization jobs to track progress, detect errors, and obtain detailed reports.

  • Real-Time Updates: Stay informed with continuous updates via Server-Sent Events (SSE), ensuring you receive notifications as the job progresses.

Loyalty Program APIs​

The Loyalty APIs provide comprehensive management for blockchain-based loyalty programs on the Stellar network. These APIs enable you to configure loyalty settings, manage user accounts, and handle tokenized rewards.

Key Features​

  • Settings Management: Configure and update loyalty program settings for your applications, including asset configurations and program parameters.

  • Account Lifecycle: Initialize and manage user accounts for loyalty programs, including setup and destruction workflows with Stellar blockchain integration. (Note: Account setup and destruction endpoints are not part of this OpenAPI documentation).

  • Public Access: Retrieve loyalty program information using application domains for public-facing integrations.

  • Blockchain Integration: Seamlessly interact with Stellar network for account operations, asset management, and transaction processing.

Zelty Integration APIs​

The Zelty APIs facilitate the integration of the loyalty program with the Zelty POS system.

Zelty Public API​

Endpoints for public interactions related to Zelty integration.

  • Account Retrieval: Get loyalty account details using application and Zelty customer IDs.
  • Configuration Access: Fetch loyalty and Zelty-specific settings based on restaurant IDs.
  • Point Burning: Allow burning of loyalty points for customer orders.
  • Webhook Handling: Process incoming webhooks from Zelty for events like order completion.

Zelty Admin API (Internal)​

Endpoints for administrative management of Zelty integration settings and restaurant linking. (Note: These admin endpoints are not part of this OpenAPI documentation).

Authentication​

Your API key

Security Scheme Type:

apiKey

Header parameter name:

X-Api-Key