Ferramentas de integração

Escolha a ferramenta adequada para explorar o contrato, testar chamadas e apoiar a implementação. Todas usam a mesma API REST e a mesma credencial vinculada a ambiente e projeto.

Referência OpenAPI

A referência interativa é a fonte completa de endpoints, schemas, parâmetros, respostas e erros. O schema JSON também pode alimentar validadores e geradores de cliente.

Postman

Baixe a collection única do Postman. Defina a variável token no environment selecionado; a API key determina se a chamada acessa HML ou PRD.

Mantenha IDs, códigos e chaves idempotentes no environment correspondente para evitar misturar dados entre testes e produção.

Insomnia

O workspace do Insomnia inclui os endpoints e environments de HML e PRD. Preencha localmente a credencial de cada ambiente.

MCP oficial

O MCP executa localmente no cliente de IA, fornece contexto sobre a jornada de integração e disponibiliza ferramentas da API REST. Configure CUPOM_API_KEY no host MCP e proteja a credencial como qualquer segredo do backend.

{
  "mcpServers": {
    "cupom-center": {
      "command": "npx",
      "args": ["-y", "@cupom_center/mcp@latest"],
      "env": { "CUPOM_API_KEY": "cpm_..." }
    }
  }
}