API
Start a supported API integration
Choose the customer contract, confirm access, and make a safe first request.
Choose the right contract
Use the customer OpenAPI file at /openapi.json. It contains 96 classified customer operations across 73 paths in this RC1 source baseline.
Do not build against a route seen only in the Pūnaha interface or controlled internal contract. An /api/ address does not by itself make an operation supported for customer integration.
Check the lifecycle
Read the Stable or Preview label before choosing an operation. Preview operations may change. Keep the saved contract, Product version, and client version together.
Prepare safe test state
- Use an isolated development tenant.
- Create only fictitious identities and records.
- Grant the test actor the smallest required action.
- Choose a request ID that contains no personal information.
- Keep tokens and cookies outside source control.
Make the first request
Start with GET /health/ready. Then sign in using a supported current Product mechanism and read one resource that the actor is allowed to view.
Keep the evidence
Record the HTTP status, stable error code, and returned x-request-id. Do not store passwords, session tokens, customer documents, or unnecessary response content.
Next step
Read Use tenant and access context before a protected request. Use the API overview to choose an API area.
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.