O contrato OpenAPI

A Referência da API — todos os endpoints, campos, limites, exemplos e códigos de erro — é gerada a partir de um documento OpenAPI 3.1 versionado no repositório desta documentação:

openapi/sipru-erp-partner-v1.yaml

Por que isso importa para você

Esse arquivo não é um subproduto da documentação — é o contrato. Você pode baixá-lo e:

• gerar um cliente na sua linguagem, em vez de escrever as chamadas à mão;
• validar os seus payloads em teste, antes de bater no ambiente da Sipru;
• importar no Postman ou no Insomnia para explorar os endpoints.

O botão Download no topo da referência entrega o mesmo arquivo.

Quando as páginas e o YAML discordarem

O YAML está certo e a página está velha. As páginas desta seção explicam como usar o contrato — a ordem das chamadas, o que fazer quando um link expira, para onde o pedido volta. O que cada campo aceita é o YAML que define.

Toda mudança de contrato passa por ele primeiro, e o info.version sobe quando algo quebra para quem já integra.