Audácia
← Voltar ao portal Developers
Developers / Integração / OpenAPI 3.1: importar a especificação

OpenAPI 3.1: importar a especificação

O Audácia disponibiliza a especificação em /developers/openapi.json, que pode ser aberta por leitores de OpenAPI 3.1 e utilizada para explorar rotas e permissões.

Conteúdo confirmado

Atenção aos contratos parciais

Os endpoints possuem x-audacia-contract-completeness. O valor route-only informa que o método e a rota foram confirmados, mas não que todos os campos de requisição e resposta foram documentados. request-partial indica que apenas parte da validação de entrada está descrita. Não gere clientes de produção presumindo que campos ausentes são proibidos ou que respostas não especificadas obedecem a um esquema comum.

Como importar

  1. Acesse https://audacia.com.br/developers/openapi.json.
  2. Importe a URL ou seu conteúdo em uma ferramenta compatível com OpenAPI 3.1.
  3. Configure o token apenas no seu ambiente de desenvolvimento autorizado.
  4. Faça testes de leitura em homologação antes de qualquer operação de escrita.
  5. Consulte os guias específicos e o histórico de mudanças antes de publicar uma integração.

O JSON não contém tokens nem exemplos com dados pessoais reais. A emissão e revogação de tokens continua pelas ferramentas internas existentes; não há OAuth público anunciado nesta versão.