Documentación de la API

Integra el correo físico directamente en tu software. Nuestra API REST utiliza solicitudes JSON y códigos de respuesta HTTP estándar.

Autenticación

Autentica tus solicitudes API incluyendo tu clave API secreta en el Authorization encabezado Authorization como un token Bearer.

Administra tus claves API →

Enviar una Postal

Poner en cola una nueva postal para procesamiento por lotes diario. Las postales se imprimen en cartulina brillante de 120 lb y se entregan a USPS.

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

Parámetros del cuerpo

toobject • required

La dirección de destino del destinatario. Debe incluir: name, address_line1, city, state, and zip.

front.image_urlstring • required

Una URL accesible públicamente a una imagen JPG o PNG de alta resolución. Debe tener menos de 20MB.

back.messagestring • required

El mensaje a imprimir en el reverso de la tarjeta. Máximo 350 caracteres.

sizestring • optional

Por defecto 4x6 . Valores aceptados: 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://tu-dominio.com/imagenes/arte.jpg"
    },
    "back": {
      "message": "¡Gracias por suscribirte a nuestro plan empresarial!"
    },
    "size": "4x6"
  }'

201 Created

{
  "id": "sap_order_94812",
  "status": "pending_batch",
  "amount": 1.75,
  "message": "Postal puesta en cola para procesamiento por lotes diario."
}