Integrate¶
How to call MasteryHive partner APIs — from first credentials to production support.
Audience: Partner
Product pages describe what; these pages describe how. Engineering runbooks stay on the internal site.
Start here¶
- Integration lifecycle
- Base URLs · Multi-tenancy · Conventions
- Product quickstart → examples → OpenAPI
Guides¶
| Guide | Purpose |
|---|---|
| Lifecycle | Discovery → production support |
| Conventions | JSON, timestamps, ids, HTTP |
| Fraud auth tutorial | JWT ApiKey, claims, rotation, 401s |
| Multi-tenancy | x-tenant-id, tenant_id, partner_id, userId, … |
| Base URLs | Confirmed local hosts; cloud = owner decision |
| Fraud report callback | What your backend must expose |
| Events (external) | External async contracts (not internal topics) |
| Error catalogue | Codes → retry / actions |
| Retry & idempotency | Decision tables |
| Versioning proposal | Not yet org policy |
| API changelog | Contract history |
| API collection | Postman templates |
Quickstarts¶
| Product | Quickstart | Examples | OpenAPI |
|---|---|---|---|
| Fraud | Quickstart | Examples | Fraud OpenAPI |
| KYC / KYB | Quickstart | Examples | KYC OpenAPI |
| Reconciliation | Quickstart | Examples | Recon OpenAPI |
Negative examples · Auth and tenancy
Principles¶
- Prefer OpenAPI for HTTP shapes; named markdown contracts for invariants OpenAPI misses.
- Design for retries with stable ids — retry tables.
- Do not invent fields absent from schemas.
- Cloud API hostnames require an owner decision until published — base URLs.