Visão geral
Todos os endpoints e webhooks da API da CartaFlow, com cada campo, valor e erro.
A referência descreve cada endpoint da API: os parâmetros, o corpo da requisição campo a campo, as respostas e os erros possíveis, com exemplos em várias linguagens. Para entender os conceitos antes, comece pelos Guias.
URL base e autenticação
Todas as requisições vão para https://api.cartaflow.com.br/v1 e levam a chave de API, que começa com cf_live_, no cabeçalho Authorization: Bearer. Crie as chaves no painel, em Desenvolvedores > Chaves de API, e chame a API só do seu servidor. Veja Autenticação.
curl https://api.cartaflow.com.br/v1/balance \
-H "Authorization: Bearer $CARTAFLOW_API_KEY"Endpoints
| Endpoint | O que faz |
|---|---|
POST/v1/letters | Criar uma correspondência |
GET/v1/letters/{letter_id} | Consultar uma correspondência |
GET/v1/letters | Listar correspondências |
POST/v1/letters/{letter_id}/cancel | Cancelar uma correspondência |
POST/v1/letters/quote | Calcular o preço |
POST/v1/uploads | Criar um upload |
POST/v1/verifications | Criar uma verificação |
GET/v1/verifications/{verification_id} | Consultar uma verificação |
GET/v1/verifications | Listar verificações |
POST/v1/verifications/{verification_id}/check | Conferir um código |
POST/v1/verifications/{verification_id}/cancel | Cancelar ou revogar uma verificação |
GET/v1/postal-codes/{postal_code} | Consultar um CEP |
GET/v1/account | Consultar a conta |
GET/v1/balance | Consultar o saldo |
GET/v1/balance/transactions | Listar movimentações do saldo |
GET/v1/events | Listar eventos |
GET/v1/events/{event_id} | Consultar um evento |
Webhooksua URL | Eventos de correspondência |
Webhooksua URL | Eventos de verificação |
Baixe a especificação OpenAPI
A API é descrita em OpenAPI 3.1. Importe o arquivo no Postman ou no Insomnia para montar as chamadas, ou use em um gerador de código para criar um cliente na sua linguagem.
- OpenAPI em português: descrições em português.
- OpenAPI em inglês: descrições em inglês.
Os dois arquivos descrevem exatamente a mesma API. Só o texto das descrições muda.
Antes de começar
- Convenções: IDs, datas, valores em centavos, cabeçalhos e status HTTP.
- Erros: o formato de todas as respostas de erro e o significado de cada código.
- Idempotência: como repetir uma requisição sem criar nada duas vezes.