Skip to content

Environments

The Integrations API is designed for two isolated environments.

Sandbox Production
Purpose Build and test your integration Real Buyers and licenses
Base URL Issued during Seller onboarding Issued after your integration is approved
API key Sandbox key Production key
Webhook environment value sandbox production
Data Test products and fictitious Buyers Real orders

Base URLs in this documentation use the reserved .example domain, for example https://sandbox-api.licenchain.example. Replace them with the base URL issued to you; do not send real credentials to any host that LicenChain has not given you.

Read the base URL and key from environment variables or your secret manager:

Terminal window
LICENCHAIN_API_BASE_URL=https://sandbox-api.licenchain.example
LICENCHAIN_API_KEY=... # secret, never committed
LICENCHAIN_WEBHOOK_SECRET=... # secret, never committed

Use fictitious organizations and role mailboxes in Sandbox, such as Example Research Cooperative and licensing@example.com. Do not copy real customer names, personal data or contract documents into Sandbox requests.

The path contains the major version (/v1/). Additive changes — new optional fields, new enum values, new event types — can be introduced without a new major version, so parse responses tolerantly and treat unknown status or reason values as deny. Breaking changes require a new major version and are announced in the Changelog.