OpenAPI specification
Download the OpenAPI 3.1 description of the partner endpoints to generate a client or import it into Postman.
The partner reference is also available as an OpenAPI 3.1 document, generated from the same source as these pages so the two never disagree.
https://vitruve-docs-prod.web.app/partners/openapi.jsonIt contains only the endpoints a customer key reaches, so a generated client never offers a call that answers 404 or 405.
Use it
- Postman or Insomnia: import the URL as an OpenAPI collection, then set the
X-API-KeyandX-Partner-Secretheaders. Call from a registered address. - Generate a client: feed the file to a generator such as
openapi-generatororopenapi-typescript. - Validate responses: use the examples as fixtures in your tests.
What it contains
- Every partner endpoint, its path and query parameters, with types, enums and defaults.
- The two security schemes, both required on every request:
CustomerKey(X-API-Key) andPartnerSecret(X-Partner-Secret). - The error responses a partner can get.
- A realistic example response for each endpoint.
Response bodies are described by example rather than by full JSON schemas: entities are returned as Vitruve stores them, and the reference lists the fields you can rely on. Generated clients should treat bodies as loosely typed and ignore unknown fields.