Developers
RGL8R’s public API is production-first and organized around three canonical workflows. Every integration follows the same pattern: authenticate with an operator-issued integration key, pick a workflow, and run it end-to-end with curl, Postman, or an example script.
Core flow
- Your RGL8R operator issues an integration key (assisted onboarding; the secret is revealed once).
- Exchange the key for a short-lived bearer token via
POST /api/auth/token/integration. - Pick one of the three canonical workflows (below) and call the tenant endpoints with
Authorization: Bearer <token>. - Poll async jobs or feed sessions until they reach a terminal state.
- Fetch results, record workflow metadata downstream.
Three canonical workflows
- SIMA screening (smallest) — enqueue a batch against your tenant catalog, poll, fetch outcomes. See the SIMA section in
public-api-contract-v1. - TRADE feed — upload a CSV/Excel, normalize, classify-preview, review, apply to catalog. See TRADE feed contract.
- SHIP audit — upload carrier invoices, list findings, dispute, bundle into a claim submission. See SHIP finding contract and SHIP claim submission contract.
Build with TRADE API
If you are integrating classification, landed cost, or catalog feeds into your own system, start here:
- 5-Minute API Quickstart — get a token and make your first call.
- TRADE Feed Contract — upload, normalize, classify, and apply catalog data.
- Agent Integration Kit — connect AI agents and automation tools.
- Integrations Overview — n8n, Zapier, and CLI quickstarts.
Start with these docs
- Start here: 5-Minute API Quickstart
- Public API contract pack: /docs/api/public-api-contract-v1
- Agent integration kit: /docs/api/agent-integration-kit-v1
- Workflow companion contracts:
- OpenAPI artifact (current): /docs/api/openapi/rgl8r-public-api-v1.2.0
- Integrations overview: /docs/integrations/README
- Error contract: /docs/error-contract
- Integration key lifecycle (operator-assisted): /docs/integration-keys
- Webhooks: /docs/api/webhooks
What developers usually need first
Auth and access
- Use integration keys for API clients and automation.
- Use Clerk-authenticated sessions for app settings, billing, and module controls.
- Keep integration-key scope narrow and rotate keys when operators change.
Product APIs
- SHIP supports upload, findings review, and claim workflows.
- TRADE supports classification, catalog upload, SIMA screening, landed-cost calculations, and obligation checks.
- Billing and usage visibility are available from tenant-scoped billing endpoints.
Operational assumptions
- Daily caps and lower rate limits apply to Sandbox tenants.
- Professional and Enterprise tiers are designed for sustained production use.
- API clients should treat rate limits, async jobs, and partial review workflows as normal operating conditions.
Next steps
- Want the product journey first: /docs/get-started
- Want onboarding and billing expectations: /docs/get-started/plans-and-billing
- Want a human overview of TRADE and SHIP: /docs/product/what-is-rgl8r