1. Inspect the API contract
Fetch the OpenAPI document from the running instance and use it as the source of truth for supported operations and schemas.
GET /v1/openapi.json
Developer platform
Connect your software to trusted execution.
Use the versioned Nexus API to explore execution capabilities, understand authorization boundaries, and integrate against the contract exposed by your deployment.
Integration path
Start in a controlled environment.
Do not embed operator credentials in browser code or treat a successful API response as proof of a physical outcome. Keep secrets server-side and verify actual deployed feature availability.
2. Check service health
Use the health endpoint to confirm the service responds. Readiness checks may report dependency status separately.
GET /api/health
GET /v1/health/ready
3. Authenticate server-side
Send credentials from a trusted backend, assign least privilege, scope integrations to the intended organization, and rotate credentials using your operational process.
4. Design for review
Handle errors and retries deliberately. Preserve request identifiers, use idempotency where supported, and route uncertain or high-impact outcomes to human review.
Production boundary
Integration is not authorization by itself.
Only expose capabilities enabled and secured in the deployed environment. Keep API keys out of client-side code, use HTTPS in production, test organization isolation, and validate the production readiness gates before live rollout. The API specification is authoritative for the current build.