Getting Started

Use this page to prepare production access for partner APIs and merchant voucher redemption.

Partner API Onboarding

Partner API access is managed in the partner portal after onboarding is approved by the ODM business team.

Account Activation

The business team creates the partner account and sends an activation link to the approved contact. If the link expires, request a new activation link.

API Access Setup

After activation, create and configure API access in the partner portal.

Configuration	Description
API access record	Creates partner API credentials for the account.
API access status	Enables or disables API traffic for the account.
API key	Value used in the X-API-Key header.
Ed25519 keypair	Generated during API access creation. The platform stores the public key and shows the private key once.
Allowed origin	Approved IP address or FQDN for the partner system.
Callback URL	HTTPS endpoint for subscribed callback events.

IMPORTANT

API keys and private keys are production credentials. Store them in a server-side secret manager. Rotate immediately if exposure is suspected.

Request Authentication

Partner requests must include:

• X-API-Key to identify the API access record
• X-Timestamp to prevent replay (<= 5 minutes clock skew)
• X-Signature as a base64 Ed25519 signature created with the private key
• Idempotency-Key for partner write endpoints

Production Gateway

The production API base URL is shared during onboarding. All paths in this guide are relative to that base URL.

Merchant Redemption Onboarding

Merchant redemption runs in the merchant portal by default. For server-to-server redemption, merchant administrators can create merchant API credentials.

Account Activation

Merchant users receive portal access from the ODM business team or an authorized merchant administrator.

Redemption Readiness

Before processing vouchers, confirm:

Requirement	Description
Active portal access	Operator can sign in to the merchant portal.
Redemption permission	Operator can validate vouchers and create claims.
OTP handoff process	Operator can collect OTP from the voucher owner at checkout.
Merchant API credentials	Required only for server-to-server redemption. The portal generates an Ed25519 keypair and shows the private key once.

Next Steps

• Partner APIs
• Merchant Redemption
• Request Authentication
• Catalog Browsing
• Idempotency