OpenAPI specification

The full OpenAPI 3.0 specification for the Partner API is the source of truth for the API Reference. Use it to generate a typed client, drive contract tests, or validate request/response payloads.

Download

• openapi.yaml (Partner API v1) - YAML

The spec is published with the portal. Every published change is documented in the Changelog.

Client generation

Generate a client for your stack with any OpenAPI-compatible generator. Examples:

# TypeScript / Node.js
npx openapi-typescript openapi.yaml -o partner-api.d.ts

# Python
openapi-python-client generate --path openapi.yaml

# Go
oapi-codegen -package partnerapi openapi.yaml > partnerapi.go

# Java
openapi-generator-cli generate -i openapi.yaml -g java -o ./java-client

Contract testing

We recommend running a contract test in your CI that:

1. Fetches the latest openapi.yaml from this portal.
2. Diffs it against the version pinned in your repo.
3. Fails the build if the diff includes a breaking change (removed field, changed type, removed enum value).

Tools like openapi-diff or oasdiff classify changes automatically.