Documentação da API

Integre o correio físico diretamente no seu software. Nossa API REST usa solicitações JSON e códigos de resposta HTTP padrão.

Autenticação

Autentique suas solicitações API incluindo sua chave API secreta no Authorization cabeçalho como um token Bearer.

Gerencie suas chaves API →

Invia una Cartolina

Coloca um novo cartão postal na fila para processamento em lote diário. Os cartões postais são impressos em papel couchê brilhante de 120 lb e entregues ao USPS.

POSThttps://shipapostcard.com/api/v1/postcards

Parâmetros do Corpo

toobject • required

O endereço de destino do destinatário. Deve incluir: name, address_line1, city, state, and zip.

front.image_urlstring • required

Uma URL acessível publicamente para uma imagem JPG ou PNG de alta resolução. Deve ter menos de 20 MB.

back.messagestring • required

A mensagem a ser impressa no verso do cartão. Máximo de 350 caracteres.

sizestring • optional

O padrão é 4x6 . Valores aceitos: 4x6 , 5x7 , 6x9 .

cURL Request

curl -X POST https://shipapostcard.com/api/v1/postcards \
  -H "Authorization: Bearer sap_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": {
      "name": "Jane Doe",
      "address_line1": "123 Tech Blvd",
      "address_line2": "Suite 400",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105"
    },
    "front": {
      "image_url": "https://seu-dominio.com/imagens/arte.jpg"
    },
    "back": {
      "message": "Obrigado por assinar nosso plano corporativo!"
    },
    "size": "4x6"
  }'

201 Created

{
  "id": "sap_order_94812",
  "status": "pending_batch",
  "amount": 1.75,
  "message": "Cartão postal colocado na fila para processamento em lote diário."
}