API, ambientes e contratos
| Ambiente | Base da API v2 | Finalidade |
|---|---|---|
| Sandbox | https://sandbox.assino.digital/api/v2 |
Integrações com dados sintéticos, sem cobrança |
| Homologação técnica | https://hml.assino.digital/api/v2 |
Validação interna, sujeita a agendamento |
| Produção | Ainda não publicada | O endereço definitivo será documentado após a ativação |
O endereço do portal não é a base da API. Os ambientes têm credenciais, dados e políticas separados.
Referência
Seção intitulada “Referência”A referência REST é gerada de uma cópia versionada do OpenAPI publicado pelo sandbox. Consulte a data e a release indicadas na página. A especificação da instância está disponível em /api/v2/openapi.json.
O contrato descreve rotas e formatos, não concede licença comercial, não prova habilitação de recursos opcionais e não garante autorização para um token específico.
Métodos e erros
Seção intitulada “Métodos e erros”As operações nativas usam os métodos indicados no OpenAPI. Valide o status HTTP e o corpo da resposta. Trate 401 como credencial ausente/inválida, 403 como recusa de autorização/política e 429 com espera e novas tentativas limitadas. Não repita automaticamente uma criação ou um envio cujo resultado seja incerto: consulte o recurso antes de decidir uma repetição.
Não presuma que todos os endpoints aceitam uma chave de idempotência. Essa garantia precisa estar explícita no contrato da operação.