Documentazione API

Integra la posta fisica direttamente nel tuo software. La nostra API REST utilizza richieste JSON e codici di risposta HTTP standard.

Autenticazione

Autentica le tue richieste API includendo la tua chiave API segreta nell' Authorization intestazione come token Bearer.

Gestisci le tue chiavi API →

Enviar uma Postal

Mette in coda una nuova cartolina per l'elaborazione batch giornaliera. Le cartoline sono stampate su cartoncino lucido da 120 lb e consegnate a USPS.

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

Parametri del corpo

toobject • required

L'indirizzo di destinazione del destinatario. Deve includere: name, address_line1, city, state, and zip.

front.image_urlstring • required

Un URL pubblicamente accessibile a un'immagine JPG o PNG ad alta risoluzione. Deve essere inferiore a 20 MB.

back.messagestring • required

Il messaggio da stampare sul retro della cartolina. Massimo 350 caratteri.

sizestring • optional

Il valore predefinito è 4x6 . Valori accettati: 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://il-tuo-dominio.com/immagini/arte.jpg"
    },
    "back": {
      "message": "Grazie per esserti iscritto al nostro piano aziendale!"
    },
    "size": "4x6"
  }'

201 Created

{
  "id": "sap_order_94812",
  "status": "pending_batch",
  "amount": 1.75,
  "message": "Cartolina messa in coda per l'elaborazione batch giornaliera."
}