Início rápido

Este passo a passo cria uma carta registrada (shipType=2) e a acompanha.

1. Consulte seu saldo

curl "https://app.escrybe.com.br/api/v2/balance/SEU_TOKEN"

Resposta

{ "status": 200, "status_message": "Sucesso", "data": { "account_balance": 12.50, "total_val_pending_jobs": 47.97, "dif_account_balance": 35.47 } }

dif_account_balance é quanto ainda falta depositar para que todos os pedidos pendentes sejam processados (total_val_pending_jobs - account_balance), com piso em 0 — não é o saldo restante. Quando o saldo já cobre os pedidos pendentes, ele volta como 0.

2. Valide antes de pagar (opcional)

Envie test=1 para validar o payload e o PDF sem criar o pedido nem debitar créditos.

O test aceita 1/true/yes/on para validar e 0/false/no/off para enviar de verdade. Qualquer outro valor é recusado com 400 — nunca é tratado como “não é teste”. Antes, test=2 criava um pedido real e cobrável.

curl -X POST "https://app.escrybe.com.br/api/v2/post" \
  -F "userSecurityToken=SEU_TOKEN" \
  -F "shipType=2" \
  -F "test=1" \
  -F "name=Maria Silva" \
  -F "addr1=Rua das Flores" \
  -F "street_number=100" \
  -F "zip=01001000" \
  -F "city=São Paulo" \
  -F "state=SP" \
  -F "country=Brasil" \
  -F "name_sender=Minha Empresa LTDA" \
  -F "addr1_sender=Av. Paulista" \
  -F "street_number_sender=1000" \
  -F "zip_sender=01310100" \
  -F "city_sender=São Paulo" \
  -F "state_sender=SP" \
  -F "country_sender=Brasil" \
  -F "pdfFile=@/caminho/para/carta.pdf"

O bloco do remetente é tudo ou nada. Para usar o remetente da requisição, envie name_sender, street_number_sender, zip_sender e country_sender. addr1_sender, city_sender e state_sender vão os três juntos ou nenhum — sem eles, saem do CEP. Se faltar um dos quatro, ou vier só parte dos três, o bloco inteiro vem do cadastro da sua conta — inclusive os campos que você enviou, que são sobrescritos em silêncio. Se o cadastro não tiver CEP, você recebe um 400.

3. Crie o pedido

Remova test=1 para enviar de fato. O campo data retorna o visual id do pedido — guarde-o.

Resposta

{ "status": 200, "status_message": "Sucesso - pedido aceito", "data": "2607031" }

4. Acompanhe o pedido

curl "https://app.escrybe.com.br/api/v2/get/SEU_TOKEN/2607031"

O campo status segue este ciclo de vida:

Código	Significado
0	Processando
1	Em produção
2	Créditos insuficientes
3	Impresso
4	Postado
5	Cancelado
6	Devolvido

Quando tracking for preenchido, você pode acompanhar o código dos Correios e baixar o PDF enviado, a frente do envelope, o aviso de recebimento (AR) ou a via do remetente via /api/v2/download/{securityToken}/{job_id}/{type}.

Comece aqui

Produtos

Integrações

1. Consulte seu saldo

2. Valide antes de pagar (opcional)

3. Crie o pedido

4. Acompanhe o pedido

​1. Consulte seu saldo

​2. Valide antes de pagar (opcional)

​3. Crie o pedido

​4. Acompanhe o pedido

1. Consulte seu saldo

2. Valide antes de pagar (opcional)

3. Crie o pedido

4. Acompanhe o pedido