Não é a página de referência de endpoints
Esta página explica os conceitos que atravessam toda a API. Para o contrato de cada endpoint, use o menu CDC/Webhooks ou a referência OpenAPI.
Ambientes
O ambiente é determinado pela URL base que você chama — as credenciais (
ClientId/ClientSecret) são específicas de cada ambiente.
Autenticação
Toda requisição autenticada usa um Bearer token, obtido viaClientId/ClientSecret solicitados ao nosso suporte.
Fluxo completo de autenticação
Veja como gerar o token e as boas práticas de segurança.
Formato das respostas
Os campos JSON são em português. Listas paginadas seguem sempre o mesmo formato:Erros
Toda resposta de erro segue RFC 7807 (Problem Details), com campos em português (tipo, titulo, detalhe, erros).
Formato completo de erro, CorrelationId e Idempotency-Key
Veja o formato de erro, rastreamento de requisições e reenvio seguro de operações.
Idempotência
Endpoints de criação (POST /v1/order, /v1/order/invoice, /v1/order/start-cdc-sale) aceitam o cabeçalho opcional Idempotency-Key: reenviar a mesma chave com o mesmo corpo, dentro de 24 horas, retorna a resposta original em vez de repetir a operação.
Troubleshooting
409 Conflict em POST
409 Conflict em POST
Uma
Idempotency-Key já usada com um corpo diferente, ou uma requisição concorrente com a mesma chave ainda em processamento. Veja Erros e idempotência.Erro de validação com campo erros vazio
Erro de validação com campo erros vazio
O campo
erros só é preenchido em erros de validação de payload. Erros de regra de negócio (ex.: saldo indisponível) vêm apenas em detalhe.Boas práticas de segurança
- Armazene
ClientId/ClientSecretem variáveis de ambiente ou um gerenciador de segredos — nunca no código-fonte - Nunca exponha o
ClientSecretem código client-side (app mobile, SPA) - A Parcele+ nunca solicita suas credenciais por e-mail ou telefone
Por onde continuar
Fluxo de venda CDC
A ordem de chamadas do início ao fim.
Webhooks
Notificações em tempo real sobre o pedido.
SDK .NET
Não lide com HTTP manualmente.