Introdução

A API da CartaFlow imprime, envelopa e posta correspondências pelos Correios para qualquer endereço do Brasil. O seu sistema envia um PDF e o endereço do destinatário. A CartaFlow imprime em cores ou em preto e branco, coloca a correspondência em um envelope e entrega aos Correios, como carta simples ou como carta registrada.

Pela mesma API você também:

• verifica endereços físicos, com uma correspondência que leva um código e a sua marca;
• personaliza um PDF com variáveis como {{nome}}, preenchidas em cada correspondência. Um PDF feito no Word, por exemplo, pode levar as variáveis no texto;
• envia como carta registrada, com código de rastreio dos Correios, aviso de recebimento (AR) e mão própria (MP);
• agenda envios para uma data futura;
• calcula o preço de uma correspondência antes de enviar.

Como funcionaCopiar link da seção

1. Você cria uma chave de API no painel da CartaFlow.
2. O seu servidor chama POST /v1/letters com o destinatário e o documento.
3. A CartaFlow confere o endereço e o PDF, cobra o envio do seu saldo e devolve a correspondência com status received.
4. A correspondência passa por produção, impressão e postagem. A cada mudança de status, a CartaFlow envia um evento para o seu webhook.

Todas as requisições vão para https://api.cartaflow.com.br/v1, usam JSON e levam a chave de API no cabeçalho Authorization.

curl https://api.cartaflow.com.br/v1/account \
  -H "Authorization: Bearer $CARTAFLOW_API_KEY"

Por onde começarCopiar link da seção