Este repositório contém a documentação e os artefatos da API do IXC ACS em três formatos distintos. Todos os três arquivos representam a mesma API — são apenas representações diferentes do mesmo conjunto de endpoints, voltadas para casos de uso diferentes.
Versão em Markdown da API. Pensada para leitura humana: serve como referência rápida, pode ser navegada diretamente no GitHub/editor e é útil para entender o que cada endpoint faz sem precisar de ferramentas externas.
Especificação OpenAPI (Swagger) em YAML. É a fonte canônica da API em formato padrão da indústria. Pode ser importada em ferramentas como Swagger UI, Redoc, Postman, Insomnia, gerar SDKs automaticamente e validar contratos.
Coleção do Bruno (cliente de API open-source baseado em arquivos .bru). Pronta para ser aberta no Bruno e usada para testar e executar requisições diretamente contra a API, com ambientes e autenticação já configurados.
| Arquivo | Formato | Uso principal |
|---|---|---|
acs-api-full.md |
Markdown | Leitura e referência |
acs-api-full.yml |
OpenAPI/YAML | Integração e geração de código |
bruno-acs-api/ |
Bruno (.bru) |
Testes e chamadas reais |
Os três são mantidos em sincronia e descrevem exatamente a mesma API — escolha o formato que melhor se encaixa no seu fluxo de trabalho.