API REFERENCE

Design stable contracts before integrations multiply.

A reference architecture for resource naming, versioning, errors, pagination, idempotency and audit context.

API REFERENCE

Developer contract.

A reference architecture for resource naming, versioning, errors, pagination, idempotency and audit context.

RESOURCES

Resources

Organisations, opportunities, projects, credentials, evidence and catalogue items.

VERSION

Versioning

Explicit API version and backwards-compatibility policy.

ERRORS

Errors

Stable machine-readable error codes and correlation IDs.

IDEMPOTENCY

Idempotency

Protect write operations from duplicate submission.

PAGINATION

Pagination

Cursor-based approaches for large or changing datasets.

AUDIT

Audit context

Actor, organisation, request ID and decision context where appropriate.

NEXT STEP

Discuss an integration requirement.

Production integrations require scope, identity, data classification, rate and support requirements.

Talk to the developer platform team →
Get proposalBuy / license