Referência
Contrato OpenAPI
O contrato OpenAPI 3.1 descreve as operações públicas, seus campos e exemplos. Importe o JSON na sua ferramenta HTTP ou use-o para gerar um cliente.
Nesta página
Operações descritas
| Método | Caminho | Resposta de sucesso | Referência |
|---|---|---|---|
| POST | /v1/send | 202 | Enviar código |
| GET | /v1/send/{id}/status | 200 | Consultar status |
| POST | /v1/send/{id}/verify | 200 | Verificar código |
| GET | /v1/signup-settings | 200 | Cota de cadastro |
A URL base é https://api.aut2fa.com. As operações de envio usam Bearer token; signup-settings é público.
Ao importar o contrato
- Configure a chave no ambiente do servidor ou na variável secreta da sua ferramenta.
- Use um leitor compatível com OpenAPI 3.1 e tipos anuláveis do JSON Schema.
- Preserve os bytes serializados do corpo nas retentativas idempotentes.
- Trate os campos de data anuláveis antes de formatá-los.
- Confira
validna verificação, mesmo quando o HTTP for 200.
Clientes gerados não alteram as regras do serviço. Veja clientes HTTP para exemplos com as bibliotecas nativas.
Referência em texto
llms.txt lista os guias e o contrato para ferramentas de leitura. llms-full.txt reúne o conteúdo da documentação em um único arquivo de texto.
Esses arquivos descrevem a mesma API pública documentada neste site.