Tutte le tue spedizioni tramite API ed in tempo reale

Automatizza l’invio di documenti, raccomandate, telegrammi, pubblicità con Ufficio Postale

Utili consigli per iniziare con Ufficio Postale

Prendi il token nell'apposita sezione prima di cominciare.

Usa lo strumento online o generalo via API. Imposta una data di scadenza e aggiungi una serie di Scopes per limitare le possibli azioni permesse al token.

Utilità e Informazioni

Metodi di supporto per tariffe, nazioni, indirizzi, tracciamento e codici postali.

Ottieni Tutte le Tariffe
GET /pricing/
Recupera il listino prezzi per tutti i servizi disponibili.

Ottieni Tariffa Servizio
GET /pricing/{service}
Ottiene i dettagli della tariffa per un servizio specifico.

Ottieni Nazioni per Servizio
GET /nazioni/{service}
Recupera l'elenco delle nazioni supportate per un servizio specifico.

Ottieni Elenco Nazioni Completo
GET /nazioni/
Recupera l'elenco completo delle nazioni supportate.

Elenca Indirizzi (Normalizzazione)
GET /indirizzi/
Permette la validazione e la normalizzazione di un indirizzo italiano.

Elenca DUG
GET /dug/
Restituisce l'elenco delle DUG (Denominazione Urbanistica Generica) valide.

Traccia Spedizione
GET /tracking/{id}
Recupera lo stato di tracciamento per un ID spedizione specifico.

Gestione Copertine

Metodi per la gestione di modelli di copertina personalizzati.

Elenca Copertine
GET /covers/
Recupera tutte le configurazioni di copertina salvate per il tuo account.

Crea Copertina
POST /covers/
Crea e salva una nuova configurazione di copertina personalizzata.

Ottieni Dettagli Copertina
GET /covers/{id}
Recupera i dettagli di una configurazione di copertina specifica tramite il suo ID.

Ottieni Anteprima Copertina
GET /covers/{id}/preview
Ottiene un'immagine o un PDF di anteprima di una configurazione di copertina specifica.

Telegrammi

Metodi per la gestione dei Telegrammi.

Crea Richiesta Telegramma
POST /telegrammi/
Crea una nuova richiesta di telegramma.

Elenca Telegrammi
GET /telegrammi/
Elenca le tue richieste di telegramma create in precedenza.

Ottieni Dettagli Telegramma
GET /telegrammi/{id}
Recupera i dettagli e lo stato di un telegramma specifico.

Conferma Invio Telegramma
PATCH /telegrammi/{id}
Conferma l'invio di una richiesta di telegramma creata in precedenza.

Atti Giudiziari

Metodi per la gestione degli Atti Giudiziari. Include il tracciamento.

Crea Richiesta Atto Giudiziario
POST /atti_giudiziari/
Crea una nuova richiesta per l'invio di un atto giudiziario.

Elenca Atti Giudiziari
GET /atti_giudiziari/
Elenca le tue richieste di atti giudiziari create in precedenza.

Ottieni Dettagli Atto Giudiziario
GET /atti_giudiziari/{id}
Recupera i dettagli e lo stato di uno specifico atto giudiziario.

Conferma Invio Atto Giudiziario
PATCH /atti_giudiziari/{id}
Conferma l'invio di una richiesta di atto giudiziario creata in precedenza.

Scarica Ricevuta di Accettazione
GET /atti_giudiziari/{id}/accettazione
Scarica la ricevuta di accettazione per un atto giudiziario inviato.

Scarica Ricevuta di Ritorno Digitale (AR Digitale)
GET /atti_giudiziari/{id}/destinatari/{IdDestinatario}/ardigitale
Scarica la ricevuta di ritorno digitale per uno specifico destinatario di un atto giudiziario.

Scarica Documento Archiviato
GET /atti_giudiziari/{id}/destinatari/{IdDestinatario}/archiviazione
Scarica il documento archiviato per uno specifico destinatario di un atto giudiziario.

Raccomandate

Metodi per la gestione delle Raccomandate. Include il tracciamento.

Crea Richiesta Raccomandata
POST /raccomandate/
Crea una nuova richiesta per l'invio di posta raccomandata.

Elenca Raccomandate
GET /raccomandate/
Elenca le tue richieste di posta raccomandata create in precedenza.

Ottieni Dettagli Raccomandata
GET /raccomandate/{id}
Recupera i dettagli e lo stato di una specifica raccomandata.

Conferma Invio Raccomandata
PATCH /raccomandate/{id}
Conferma l'invio di una richiesta di posta raccomandata creata in precedenza.

Scarica Ricevuta di Accettazione
GET /raccomandate/{id}/accettazione
Scarica la ricevuta di accettazione per una raccomandata inviata.

Scarica Documento Archiviato
GET /raccomandate/{id}/destinatari/{IdDestinatario}/archiviazione
Scarica il documento archiviato per uno specifico destinatario di una raccomandata.

Posta Prioritaria

Metodi per la gestione della Posta Prioritaria. Include il codice di tracciamento dello stato.

Crea Richiesta Posta Prioritaria
POST /prioritarie/
Crea una nuova richiesta per l'invio di posta prioritaria.

Elenca Posta Prioritaria
GET /prioritarie/
Elenca le tue richieste di posta prioritaria create in precedenza.

Ottieni Dettagli Posta Prioritaria
GET /prioritarie/{id}
Recupera i dettagli di una specifica posta prioritaria.

Conferma Invio Posta Prioritaria
PATCH /prioritarie/{id}
Conferma l'invio di una richiesta di posta prioritaria creata in precedenza.

Scarica Documento Archiviato
GET /prioritarie/{id}/destinatari/{IdDestinatario}/archiviazione
Scarica il documento archiviato per uno specifico destinatario di una posta prioritaria.

Posta Ordinaria

Metodi per la gestione della Posta Ordinaria.

Crea Richiesta Posta Ordinaria
POST /ordinarie/
Crea una nuova richiesta per l'invio di posta ordinaria.

Elenca Posta Ordinaria
GET /ordinarie/
Elenca le tue richieste di posta ordinaria create in precedenza.

Ottieni Dettagli Posta Ordinaria
GET /ordinarie/{id}
Recupera i dettagli di una specifica posta ordinaria.

Conferma Invio Posta Ordinaria
PATCH /ordinarie/{id}
Conferma l'invio di una richiesta di posta ordinaria creata in precedenza.

Scarica Documento Archiviato
GET /ordinarie/{id}/destinatari/{IdDestinatario}/archiviazione
Scarica il documento archiviato per uno specifico destinatario di una posta ordinaria.

Raccomandata Smart

Metodi per la gestione della Raccomandata Smart.

Crea Richiesta Raccomandata Smart
POST /raccomandate_smart/
Crea una nuova richiesta per l'invio di Raccomandata Smart.

Elenca Raccomandate Smart
GET /raccomandate_smart/
Elenca le tue richieste di Raccomandata Smart create in precedenza.

Ottieni Dettagli Raccomandata Smart
GET /raccomandate_smart/{id}
Recupera i dettagli di una specifica Raccomandata Smart.

Conferma Invio Raccomandata Smart
PATCH /raccomandate_smart/{id}
Conferma l'invio di una richiesta di Raccomandata Smart creata in precedenza.

Posta Massiva

Metodi per la gestione degli invii massivi.

Crea Richiesta Posta Massiva
POST /posta_massiva/
Crea una nuova richiesta per l'invio di posta massiva.

Elenca Posta Massiva
GET /posta_massiva/
Elenca le tue richieste di posta massiva create in precedenza.

Ottieni Dettagli Posta Massiva
GET /posta_massiva/{id}
Recupera i dettagli di una specifica richiesta di posta massiva.

Conferma Invio Posta Massiva
PATCH /posta_massiva/{id}
Conferma l'invio di una richiesta di posta massiva creata in precedenza.

Oas file url https://console.openapi.com/oas/it/ufficiopostale.openapi.json
Fork or import with Postman
Production domain ws.ufficiopostale.com
Sandbox domain test.ws.ufficiopostale.com
Production Scopes 33

Rate Limits: 10000 req/min
Sandbox Scopes 33
- DELETE test.ws.ufficiopostale.com/covers
- GET test.ws.ufficiopostale.com/atti_giudiziari
- GET test.ws.ufficiopostale.com/comuni
- GET test.ws.ufficiopostale.com/covers
- GET test.ws.ufficiopostale.com/dug
- GET test.ws.ufficiopostale.com/indirizzi
- GET test.ws.ufficiopostale.com/nazioni
- GET test.ws.ufficiopostale.com/ordinarie
- GET test.ws.ufficiopostale.com/posta_4_pro
- GET test.ws.ufficiopostale.com/posta_massiva
- GET test.ws.ufficiopostale.com/pricing
- GET test.ws.ufficiopostale.com/prioritarie
- GET test.ws.ufficiopostale.com/raccomandate
- GET test.ws.ufficiopostale.com/raccomandate_smart
- GET test.ws.ufficiopostale.com/telegrammi
- GET test.ws.ufficiopostale.com/tracking
- PATCH test.ws.ufficiopostale.com/atti_giudiziari
- PATCH test.ws.ufficiopostale.com/ordinarie
- PATCH test.ws.ufficiopostale.com/posta_4_pro
- PATCH test.ws.ufficiopostale.com/posta_massiva
- PATCH test.ws.ufficiopostale.com/prioritarie
- PATCH test.ws.ufficiopostale.com/raccomandate
- PATCH test.ws.ufficiopostale.com/raccomandate_smart
- PATCH test.ws.ufficiopostale.com/telegrammi
- POST test.ws.ufficiopostale.com/atti_giudiziari
- POST test.ws.ufficiopostale.com/covers
- POST test.ws.ufficiopostale.com/ordinarie
- POST test.ws.ufficiopostale.com/posta_4_pro
- POST test.ws.ufficiopostale.com/posta_massiva
- POST test.ws.ufficiopostale.com/prioritarie
- POST test.ws.ufficiopostale.com/raccomandate
- POST test.ws.ufficiopostale.com/raccomandate_smart
- POST test.ws.ufficiopostale.com/telegrammi

API docs by Redocly

Ufficio Postale (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Questo servizio web permette la consegna di prodotti postali come Raccomandate, Telegrammi, Posta Prioritaria tramite Poste Italiane

Creare una nuova mail con una richiesta POST
Controllare i prezzi e confermarli con un PATCH, oppure utilizzare autoconfirm: true
Ricevi gli aggiornamenti di stato del tuo messaggio fornendo un callback url

Nota: Ci sono alcune limitazioni relative alle dimensioni di un documento PDF. Leggere il campo "documento" nella descrizione dell'endpoint che si desidera utilizzare.

Gestione degli errori

Quando si verifica un errore di invio, la risposta includerà un messaggio e un data.wrong_fields: []: ogni elemento di campi_errati è una stringa che indica da dove è stato generato l'errore. Questo rende molto semplice l'integrazione nel modulo front-end, dove è possibile evidenziare le voci errate

Test

Quando si utilizza l'ambiente Sandbox, si riceveranno callback di aggiornamento poco dopo la creazione della richiesta con contenuto segnaposto. È anche possibile, per alcuni prodotti, forzare l'esecuzione del callback nell'ambiente Sandbox.

Prima volta qui? Generare un nuovo token di accesso

Ufficio Postale

Ottenere i prezzi

Restituisce un elenco di prezzi per vari tipi di servizi.

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/pricing/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "tipologia": "raccomandata",
  - "prodotto": "raccomandata",
  - "descrizione": "Raccomandata",
  - "riferimento_prezzo": "pagina",
  - "accetta_allegati": 1,
  - "attivo": 1,
  - "tariffe": [
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 0,
    "a": 1,
    "tariffa_postale": 3.4,
    "zona": 0,
    "stampa": 0.1,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 2,
    "a": 2,
    "tariffa_postale": 3.4,
    "zona": 0,
    "stampa": 0.2,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 3,
    "a": 3,
    "tariffa_postale": 3.4,
    "zona": 0,
    "stampa": 0.3,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 4,
    "a": 5,
    "tariffa_postale": 4.55,
    "zona": 0,
    "stampa": 0.3,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 6,
    "a": 9,
    "tariffa_postale": 4.55,
    "zona": 0,
    "stampa": 0.35,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 10,
    "a": 13,
    "tariffa_postale": 4.55,
    "zona": 0,
    "stampa": 0.4,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 14,
    "a": 18,
    "tariffa_postale": 4.55,
    "zona": 0,
    "stampa": 0.45,
    "imbustamento": 0
    },
    {
    "iva_tariffa_postale": 0,
    "iva_stampa_imbustamento": 0,
    "tipologia": "pagine",
    "da": 19,
    "a": 10000000,
    "tariffa_postale": 4.55,
    "zona": 0,
    "stampa": 0.45,
    "imbustamento": 0
    }
    ],
  - "options": {
    "StampaColori": {
    "nome_option": "Stampa Colori",
    "nome_option_invio": "StampaColori",
    "prezzo_option": 0.8,
    "iva": 0,
    "attivo": 1
    },
    "RicevutaRitorno": {
    "nome_option": "Ricevuta di Ritorno",
    "nome_option_invio": "RicevutaRitorno",
    "prezzo_option": 0.8,
    "iva": 0,
    "attivo": 1
    },
    "FronteRetro": {
    "nome_option": "Stampa Fronte/Retro",
    "nome_option_invio": "FronteRetro",
    "prezzo_option": 0.3,
    "iva": 0,
    "attivo": 1
    }
    },
  - "username": null
  }
],
"success": true,
"message": "",
"error": null

}

Elenco degli indirizzi

Authorizations:

bearerAuth

query Parameters

cap	string Example: cap=05100
comune	string Example: comune=terni
dug	string Example: dug=via

Responses

Response Schema: application/json

data	Array of strings
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/indirizzi/?cap=SOME_STRING_VALUE&comune=SOME_STRING_VALUE&dug=SOME_STRING_VALUE");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- "string"
],
"success": true,
"message": "string",
"error": null

}

Elenco di tutti i dispositivi disponibili

(denomiazioni urbanistiche generiche)

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/dug/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "codice_dug": "BGO",
  - "dug": "Borgo"
  }
],
"message": "1 Risultato",
"success": true,
"error": null

}

Traccia il tuo prodotto

Authorizations:

bearerAuth

path Parameters

required

string

Responses

Response Schema: application/json

	Array of objects
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/tracking/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "timestamp": 1604567446,
  - "descrizione": "accettata online",
  - "type": "00",
  - "definitivo": false
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Ottenere informazioni su un codice postale Deprecated

Authorizations:

bearerAuth

path Parameters

code

required

string

Example: 05100

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/comuni/05100");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "nome_provincia": "Terni",
  - "sigla_provincia": "TR",
  - "regione": "Umbria",
  - "comuni": [
    "Terni"
    ],
  - "dettaglio_comuni": [
    {
    "nome": "Terni",
    "popolazione": 109193,
    "codice_catastale": "L117",
    "codice_istat": "055032"
    }
    ]
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Telegrammi

Ottenere informazioni su un telegramma

Authorizations:

bearerAuth

path Parameters

required

string

query Parameters

ricevuta	string Example: ricevuta=1 Se l'opzione è stata impostata, restituisce un file PDF come file ricevuto.
state	string Example: state=NEW Se l'opzione è stata impostata, restituisce uno schema specifico con uno stato uguale a quello richiesto.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/telegrammi/%7Bid%7D?ricevuta=1&state=NEW");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": {
- "mittente": {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "dug": "via",
  - "indirizzo": "Dante Alighieri",
  - "civico": "4",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "IT",
  - "email": "[email protected]"
  },
- "destinatari": [
  - {
    "nome": "PRIMO",
    "cognome": "ROSSI",
    "dug": "VIA",
    "indirizzo": "PRIMO MAGGIO",
    "civico": "6",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "id": "609d43e457d71a5b600ee17c",
    "state": "NEW",
    "IdRicevuta": "WG55505B956001"
    }
  ],
- "documento": [
  - "Test document"
  ],
- "opzioni": {
  - "ar_c": {
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "Dante Alighieri",
    "civico": "4",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "fronteretro": false,
  - "colori": false,
  - "autoconfirm": true,
  - "mittente": false,
  - "ar_e": false,
  - "timestamp_invio": 1620919269
  },
- "prodotto": "telegramma",
- "creation_timestamp": 1620919268,
- "update_timestamp": 1620919779,
- "username": "[email protected]",
- "confirmed": true,
- "state": "SENT",
- "documento_validato": {
  - "pdf": "https://ws.ufficiopostale.com/Up/pdf/0000000eeaaaa11111111xxxxx.pdf",
  - "jpg": "https://ws.ufficiopostale.com/Up/jpg/0000000eeaaaa11111111xxxxx.jpg",
  - "parole": 2,
  - "size": 11
  },
- "pricing": {
  - "dettaglio": [
    {
    "codice_servizio": "RicevutaRitornoCartacea",
    "descrizione_servizio": "Ricevuta cartacea",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 7.93,
    "importo_unitario_netto": 6.5,
    "importo_unitario_iva": 1.4300000000000002
    },
    {
    "codice_servizio": "parole",
    "descrizione_servizio": "Tariffa Postale parole",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 4.27,
    "importo_unitario_netto": 3.5,
    "importo_unitario_iva": 0.77
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    }
    ],
  - "totale": {
    "importo_totale_netto": 10,
    "importo_totale_iva": 2.2,
    "importo_totale": 12.2
    }
  },
- "confirmed_timestamp": 1620919269,
- "GuidUtente": "xxxxxx-ae90-48b5-bec1-abcdefg",
- "IDRichiesta": "xxxxxx-ae90-48b5-bec1-abcdefg",
- "sending_timestamp": 1620919746,
- "substate": "SENT",
- "error": null,
- "error_timestamp": 1620919356,
- "sent_timestamp": 1620919779,
- "id": "xxxxxxxe557d71a5b600ee17d"
},
"message": "",
"success": true,
"error": null

}

Confermare l'invio di un telegramma

Confermare l'invio di un telegramma creato con "autoconfirm = false".

Authorizations:

bearerAuth

path Parameters

required

string

Request Body schema: application/json

confirmed

boolean

Responses

Request samples

Content type

application/json

{

"confirmed": true

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "ragione_sociale": "Mario Rossi Srl",
    "dug": "Viale",
    "indirizzo": "dei Giardini",
    "civico": "82",
    "comune": "san dona' di piave",
    "cap": "30027",
    "provincia": "VE",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "ragione_sociale": "prova spa",
    "dug": "viale",
    "indirizzo": "rossi mario",
    "civico": "82",
    "comune": "san dona' di piave",
    "cap": "30027",
    "provincia": "VE",
    "nazione": "IT",
    "id": "649998d25b295d43ac0f1e78",
    "state": "NEW"
    }
    ],
  - "documento": [
    "tmpfiles.org/dl/980693/br223_compressed.pdf"
    ],
  - "opzioni": {
    "fronteretro": true,
    "colori": true,
    "ar": false,
    "ricevuta": false,
    "autoconfirm": false,
    "timestamp_invio": 1687787732
    },
  - "prodotto": "raccomandata",
  - "creation_timestamp": 1687787729,
  - "update_timestamp": 1687787742,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://alpha.ws.ufficiopostale.com/Up/pdf/raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.pdf",
    "jpg": "https://alpha.ws.ufficiopostale.com/Up/jpg/raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.jpg",
    "filename": "raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.pdf",
    "pagine": 1,
    "size": 6308
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "FronteRetro",
    "descrizione_servizio": "Fronte Retro",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.05,
    "importo_unitario_netto": 0.05,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "StampaColori",
    "descrizione_servizio": "Stampa Colori",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.8,
    "importo_unitario_netto": 0.8,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa postale pagine",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_netto": 3.92,
    "importo_unitario_iva": 0,
    "importo_unitario_totale": 3.92
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_netto": 0.32,
    "importo_unitario_iva": 0,
    "importo_unitario_totale": 0.32
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_netto": 0.12,
    "importo_unitario_iva": 0,
    "importo_unitario_totale": 0.12
    }
    ],
    "totale": {
    "importo_totale_netto": 5.21,
    "importo_totale_iva": 0,
    "importo_totale": 5.21
    }
    },
  - "confirmed_timestamp": 1687787742,
  - "id": "649998d45b295d43ac0f1e79"
  }
],
"success": true,
"message": "",
"error": null

}

Elenco dei telegrammi

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/telegrammi/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "cognome": "Rossi",
    "email": "[email protected]"
    },
  - "creation_timestamp": 1620919268,
  - "update_timestamp": 1620919779,
  - "confirmed": true,
  - "state": "SENT",
  - "error": null,
  - "id": "xxxxxxxe557d71a5b600ee17d"
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Inviare un telegramma. Nel corpo del messaggio si

Inviare un telegramma. Nel corpo del messaggio si devono fornire informazioni sul mittente e sul/i destinatario/i. Inoltre, il parametro "autoconfirm" può essere impostato su false per salvare il telegramma per una successiva conferma con una richiesta PATCH, mentre si esegue una logica personalizzata con la risposta.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
	object
	Array of objects (Recipient)
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.

Responses

Response Schema: application/json

	object
	object
	Array of objects
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.
	object (documento_validato) L'output del processo di generazione dei documenti.

Callbacks

Request samples

Content type

application/json

{

"mittente": {
- "titolo": "mr",
- "nome": "Mario",
- "cognome": "Rossi",
- "dug": "Via",
- "indirizzo": "Dante Alighieri",
- "civico": "1",
- "comune": "Roma",
- "cap": "00100",
- "provincia": "RM",
- "nazione": "Italia",
- "email": "[email protected]"
},
"destinatari": [
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "via",
  - "indirizzo": "Dante Alighieri",
  - "civico": "6",
  - "comune": "Roma",
  - "cap": "00101",
  - "provincia": "RE",
  - "nazione": "Italia"
  },
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "piazza",
  - "indirizzo": "San Giovanni",
  - "civico": "6",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "Italia"
  }
],
"documento": [
- "Example document"
],
"opzioni": {
- "autoconfirm": true
}

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Alberto",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "Dante Alighieri",
    "civico": "2b",
    "comune": "verona",
    "cap": "37138",
    "provincia": "vr",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "nome": "Mario",
    "cognome": "Rossi",
    "co": "OPENAPI SRL",
    "dug": "VIA",
    "indirizzo": "Dante Alighieri",
    "civico": "6",
    "comune": "Roma",
    "cap": "00101",
    "provincia": "RE",
    "nazione": "IT",
    "id": "61041dc0ac2b1f63327e92d0",
    "state": "NEW"
    },
    {
    "nome": "Mario",
    "cognome": "Rossi",
    "co": "OPENAPI SRL",
    "dug": "PIAZZA",
    "indirizzo": "San Giovanni",
    "civico": "6",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "id": "61041dc0ac2b1f63327e92d1",
    "state": "NEW"
    }
    ],
  - "documento": "lorem ipsum",
  - "opzioni": {
    "autoconfirm": true,
    "mittente": false,
    "ar_c": false,
    "ar_e": false,
    "timestamp_invio": 1627659712
    },
  - "prodotto": "telegramma",
  - "creation_timestamp": 1627659712,
  - "update_timestamp": 1627659712,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://ws.ufficiopostale.com/Up/pdf/test-document.pdf",
    "jpg": "https://ws.ufficiopostale.com/Up/jpg/test-document.jpg",
    "parole": 1,
    "txt": "L",
    "size": 1
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "parole",
    "descrizione_servizio": "Tariffa Postale parole",
    "percentuale_iva": 22,
    "quantita": 2,
    "importo_unitario_totale": 4.27,
    "importo_unitario_netto": 3.5,
    "importo_unitario_iva": 0.77
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 22,
    "quantita": 2,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 2,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    }
    ],
    "totale": {
    "importo_totale_netto": 7,
    "importo_totale_iva": 1.54,
    "importo_totale": 8.54
    }
    },
  - "lock": false,
  - "confirmed_timestamp": 1627659712,
  - "id": "61041dc0ac2b1f63327e92d2"
  }
],
"success": true,
"message": "",
"error": null

}

Callback payload samples

Callback

POST: {$request.body#/opzioni/callback_url}

Content type

application/json

{

"mittente": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string"
},
"destinatari": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string",
- "id": "string",
- "state": "string"
},
"documento": [
- "string"
],
"opzioni": {
- "fronteretro": true,
- "colori": true,
- "autoconfirm": true,
- "callback_url": "string",
- "timestamp_invio": 0
},
"prodotto": "string",
"creation_timestamp": 0,
"update_timestamp": 0,
"username": "string",
"confirmed": true,
"state": "string",
"documento_validato": {
- "pdf": "string",
- "jpg": "string",
- "filename": "string",
- "pagine": 0,
- "size": 0
},
"pricing": {
- "totale": {
  - "importo_totale": 0
  },
- "dettaglio": [
  - {
    "codice_servizio": "string",
    "descrizione_servizio": "string",
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0,
    "quantita": 0
    }
  ]
},
"confirmed_timestamp": 0,
"id": "string"

}

Raccomandate

Questo prodotto offre un codice di tracciamento

Elenca il tuo Raccomandato

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/raccomandate/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Alberto",
    "cognome": "Rossi",
    "email": "[email protected]"
    },
  - "creation_timestamp": 1608040424,
  - "update_timestamp": 1608040424,
  - "confirmed": false,
  - "state": "NEW",
  - "id": "5fd8bfeaa10b340e2e558db7"
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Inviare una Raccomandata. Nel corpo del messaggio

Inviare una Raccomandata. Nel corpo del messaggio si devono fornire informazioni sul mittente e sul/i destinatario/i. Inoltre, il parametro "autoconfirm" può essere impostato su false per salvare la Raccomandata per una successiva conferma con una richiesta PATCH, mentre si esegue una logica personalizzata con la risposta. Controllare il campo NumeroRaccomandata nell'oggetto destinatario se si ha bisogno del numero di tracciamento.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
	object
	Array of Recipient (object) or Casella postale (object) (Recipient or Casella postale)
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.

Responses

Response Schema: application/json

	object
	object
	Array of objects
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.
	object (documento_validato) L'output del processo di generazione dei documenti.

Callbacks

Request samples

Content type

application/json

{

"mittente": {
- "titolo": "mr",
- "nome": "Mario",
- "cognome": "Rossi",
- "dug": "Via",
- "indirizzo": "Dante Alighieri",
- "civico": "1",
- "comune": "Roma",
- "cap": "00100",
- "provincia": "RM",
- "nazione": "Italia",
- "email": "[email protected]"
},
"destinatari": [
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "via",
  - "indirizzo": "Dante Alighieri",
  - "civico": "6",
  - "comune": "Roma",
  - "cap": "00101",
  - "provincia": "RE",
  - "nazione": "Italia"
  },
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "piazza",
  - "indirizzo": "San Giovanni",
  - "civico": "6",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "Italia"
  }
],
"documento": [
- "Example document"
],
"opzioni": {
- "fronteretro": false,
- "colori": false,
- "ar": true,
- "autoconfirm": true
}

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "titolo": "mr",
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "Via",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "Roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "nome": "Mario",
    "cognome": "Rossi",
    "co": "OPENAPI SRL",
    "dug": "via",
    "indirizzo": "Dante Alighieri",
    "civico": "6",
    "comune": "Roma",
    "cap": "00101",
    "provincia": "RE",
    "nazione": "IT",
    "id": "6103f711dd2507415c5db6ce",
    "state": "NEW"
    },
    {
    "nome": "Mario",
    "cognome": "Rossi",
    "co": "OPENAPI SRL",
    "dug": "piazza",
    "indirizzo": "San Giovanni",
    "civico": "6",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "id": "6103f711dd2507415c5db6cf",
    "state": "NEW"
    }
    ],
  - "documento": [
    "Example document"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": false,
    "ar": {
    "titolo": "mr",
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "Via",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "Roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
    "autoconfirm": true,
    "timestamp_invio": 1627649810
    },
  - "prodotto": "raccomandata",
  - "creation_timestamp": 1627649809,
  - "update_timestamp": 1627649810,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf",
    "jpg": "https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg",
    "pagine": 1,
    "size": 9350
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "RicevutaRitorno",
    "descrizione_servizio": "Ricevuta di Ritorno",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0.8,
    "importo_unitario_netto": 0.8,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa Postale pagine",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 3.4,
    "importo_unitario_netto": 3.4,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0.1,
    "importo_unitario_netto": 0.1,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    }
    ],
    "totale": {
    "importo_totale_netto": 8.6,
    "importo_totale_iva": 0,
    "importo_totale": 8.6
    }
    },
  - "lock": false,
  - "confirmed_timestamp": 1627649810,
  - "id": "6103f712dd2507415c5db6d0"
  }
],
"success": true,
"message": "",
"error": null

}

Callback payload samples

Callback

POST: {$request.body#/opzioni/callback_url}

Content type

application/json

{

"mittente": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string"
},
"destinatari": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string",
- "id": "string",
- "state": "string"
},
"documento": [
- "string"
],
"opzioni": {
- "fronteretro": true,
- "colori": true,
- "autoconfirm": true,
- "callback_url": "string",
- "timestamp_invio": 0
},
"prodotto": "string",
"creation_timestamp": 0,
"update_timestamp": 0,
"username": "string",
"confirmed": true,
"state": "string",
"documento_validato": {
- "pdf": "string",
- "jpg": "string",
- "filename": "string",
- "pagine": 0,
- "size": 0
},
"pricing": {
- "totale": {
  - "importo_totale": 0
  },
- "dettaglio": [
  - {
    "codice_servizio": "string",
    "descrizione_servizio": "string",
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0,
    "quantita": 0
    }
  ]
},
"confirmed_timestamp": 0,
"id": "string"

}

Ottenere informazioni su una Raccomandata

Controllare il campo NumeroRaccomandata nell'oggetto destinatario se si ha bisogno del numero di tracciamento.

Authorizations:

bearerAuth

path Parameters

required

string

query Parameters

ricevuta	string Example: ricevuta=1 Se l'opzione è stata impostata, restituisce un file PDF come file ricevuto.
state	string Example: state=NEW Se l'opzione è stata impostata, restituisce uno schema specifico con uno stato uguale a quello richiesto.
callback	string Example: callback=<empty string> Simula l'avanzamento dello stato della spedizione: ogni volta che questo endpoint viene chiamato, la richiesta avanza allo stato di spedizione successivo. Se specificato nella richiesta, si riceveranno aggiornamenti di callback. Si noti che questa opzione è disponibile SOLO per l'ambiente sandbox.

Responses

Response Schema: application/json

	object
message	string
success	boolean
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/raccomandate/%7Bid%7D?ricevuta=1&state=NEW&callback=%3Cempty%20string%3E");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": {
- "mittente": {
  - "nome": "Mario",
  - "cognome": "Bianchi",
  - "dug": "piazza",
  - "indirizzo": "italia",
  - "civico": "10",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "IT",
  - "state": "SENT"
  },
- "destinatari": [
  - {
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "piazza",
    "indirizzo": "italia",
    "civico": "10",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "id": "000000000000000000000000",
    "state": "SENT",
    "NumeroRaccomandata": "123412341234"
    }
  ],
- "documento": [
  - "Test di invio"
  ],
- "opzioni": {
  - "fronteretro": false,
  - "colori": true,
  - "ar": {
    "nome": "Mario",
    "cognome": "Bianchi",
    "dug": "piazza",
    "indirizzo": "italia",
    "civico": "10",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "state": "SENT"
    },
  - "ricevuta": false,
  - "autoconfirm": false,
  - "callback_url": "https://webhook.site/1231234124",
  - "timestamp_invio": 1662372837
  },
- "prodotto": "raccomandata",
- "creation_timestamp": 1662372836,
- "update_timestamp": 1662372836,
- "username": "[email protected]",
- "confirmed": false,
- "state": "NEW",
- "documento_validato": {
  - "pdf": "https://xxxxxxxxx.pdf",
  - "jpg": "https://xxxxxxxxx.jpg",
  - "filename": "example.pdf",
  - "pagine": 1,
  - "size": 4513
  },
- "pricing": {
  - "dettaglio": [
    {
    "codice_servizio": "StampaColori",
    "descrizione_servizio": "Stampa Colori",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0.976,
    "importo_unitario_netto": 0.8,
    "importo_unitario_iva": 0.176
    },
    {
    "codice_servizio": "RicevutaRitorno",
    "descrizione_servizio": "Ricevuta di Ritorno",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.8,
    "importo_unitario_netto": 0.8,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa Postale pagine",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 3.4,
    "importo_unitario_netto": 3.4,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 20,
    "quantita": 1,
    "importo_unitario_totale": 0.12000000000000001,
    "importo_unitario_netto": 0.1,
    "importo_unitario_iva": 0.02
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 1.2,
    "importo_unitario_netto": 1,
    "importo_unitario_iva": 0.2
    }
    ],
  - "totale": {
    "importo_totale_netto": 6.1,
    "importo_totale_iva": 0.396,
    "importo_totale": 6.4959999999999996
    }
  },
- "id": "4242424242424242424242"
},
"message": "",
"success": true,
"error": null

}

Confermare l'invio di una Raccomandata creata con

Confermare l'invio di una Raccomandata creata con "autoconfirm = false".

Authorizations:

bearerAuth

path Parameters

required

string

Request Body schema: application/json

confirmed

boolean

Responses

Request samples

Content type

application/json

{

"confirmed": true

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "ragione_sociale": "Mario Rossi Srl",
    "dug": "Viale",
    "indirizzo": "dei Giardini",
    "civico": "82",
    "comune": "san dona' di piave",
    "cap": "30027",
    "provincia": "VE",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "ragione_sociale": "prova spa",
    "dug": "viale",
    "indirizzo": "rossi mario",
    "civico": "82",
    "comune": "san dona' di piave",
    "cap": "30027",
    "provincia": "VE",
    "nazione": "IT",
    "id": "649998d25b295d43ac0f1e78",
    "state": "NEW"
    }
    ],
  - "documento": [
    "tmpfiles.org/dl/980693/br223_compressed.pdf"
    ],
  - "opzioni": {
    "fronteretro": true,
    "colori": true,
    "ar": false,
    "ricevuta": false,
    "autoconfirm": false,
    "timestamp_invio": 1687787732
    },
  - "prodotto": "raccomandata",
  - "creation_timestamp": 1687787729,
  - "update_timestamp": 1687787742,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://alpha.ws.ufficiopostale.com/Up/pdf/raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.pdf",
    "jpg": "https://alpha.ws.ufficiopostale.com/Up/jpg/raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.jpg",
    "filename": "raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.pdf",
    "pagine": 1,
    "size": 6308
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "FronteRetro",
    "descrizione_servizio": "Fronte Retro",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.05,
    "importo_unitario_netto": 0.05,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "StampaColori",
    "descrizione_servizio": "Stampa Colori",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.8,
    "importo_unitario_netto": 0.8,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa postale pagine",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_netto": 3.92,
    "importo_unitario_iva": 0,
    "importo_unitario_totale": 3.92
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_netto": 0.32,
    "importo_unitario_iva": 0,
    "importo_unitario_totale": 0.32
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_netto": 0.12,
    "importo_unitario_iva": 0,
    "importo_unitario_totale": 0.12
    }
    ],
    "totale": {
    "importo_totale_netto": 5.21,
    "importo_totale_iva": 0,
    "importo_totale": 5.21
    }
    },
  - "confirmed_timestamp": 1687787742,
  - "id": "649998d45b295d43ac0f1e79"
  }
],
"success": true,
"message": "",
"error": null

}

Posta Prioritaria

Questo prodotto offre un codice per tracciare gli aggiornamenti di stato

Elencate le vostre richieste

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/prioritarie/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Alberto",
    "cognome": "Rossi",
    "email": "[email protected]"
    },
  - "creation_timestamp": 1608040424,
  - "update_timestamp": 1608040424,
  - "confirmed": false,
  - "state": "NEW",
  - "id": "5fd8bfeaa10b340e2e558db7"
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Inviare una posta prioritaria. È necessario fornir

Inviare una posta prioritaria. È necessario fornire informazioni sul mittente e sul/i destinatario/i nel corpo del messaggio. Inoltre, il parametro "autoconfirm" può essere impostato su false per salvare l'invio per una successiva conferma con una richiesta PATCH, mentre si esegue una logica personalizzata con la risposta. Controllare il campo IdRicevuta nell'oggetto destinatario se si ha bisogno del numero di tracciamento.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
	Array of Recipient (object) or Casella postale (object) (Recipient or Casella postale)
	object
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.

Responses

Response Schema: application/json

	object
	object
	Array of objects
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.
	object (documento_validato) L'output del processo di generazione dei documenti.

Callbacks

Request samples

Content type

application/json

{

"mittente": {
- "titolo": "mr",
- "nome": "Mario",
- "cognome": "Rossi",
- "dug": "Via",
- "indirizzo": "Dante Alighieri",
- "civico": "1",
- "comune": "Roma",
- "cap": "00100",
- "provincia": "RM",
- "nazione": "Italia",
- "email": "[email protected]"
},
"destinatari": [
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "via",
  - "indirizzo": "Dante Alighieri",
  - "civico": "6",
  - "comune": "Roma",
  - "cap": "00101",
  - "provincia": "RE",
  - "nazione": "Italia"
  },
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "piazza",
  - "indirizzo": "San Giovanni",
  - "civico": "6",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "Italia"
  }
],
"documento": [
- "Example document"
],
"opzioni": {
- "fronteretro": false,
- "colori": false,
- "ar": true,
- "autoconfirm": true
}

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "titolo": "mr",
    "nome": "John",
    "cognome": "Doe",
    "dug": "Piazza",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "titolo": "mr",
    "nome": "John",
    "cognome": "Doe",
    "dug": "Piazza",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    }
    ],
  - "documento": [
    "Example document"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": false,
    "autoconfirm": true,
    "timestamp_invio": 1627649810
    },
  - "prodotto": "raccomandata",
  - "creation_timestamp": 1627649809,
  - "update_timestamp": 1627649810,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf",
    "jpg": "https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg",
    "pagine": 1,
    "size": 9350
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    }
    ],
    "totale": {
    "importo_totale_netto": 8.6,
    "importo_totale_iva": 0,
    "importo_totale": 8.6
    }
    },
  - "lock": false,
  - "confirmed_timestamp": 1627649810,
  - "id": "6103f712dd2507415c5db6d0"
  }
],
"success": true,
"message": "",
"error": null

}

Callback payload samples

Callback

POST: {$request.body#/opzioni/callback_url}

Content type

application/json

{

"mittente": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string"
},
"destinatari": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string",
- "id": "string",
- "state": "string"
},
"documento": [
- "string"
],
"opzioni": {
- "fronteretro": true,
- "colori": true,
- "autoconfirm": true,
- "callback_url": "string",
- "timestamp_invio": 0
},
"prodotto": "string",
"creation_timestamp": 0,
"update_timestamp": 0,
"username": "string",
"confirmed": true,
"state": "string",
"documento_validato": {
- "pdf": "string",
- "jpg": "string",
- "filename": "string",
- "pagine": 0,
- "size": 0
},
"pricing": {
- "totale": {
  - "importo_totale": 0
  },
- "dettaglio": [
  - {
    "codice_servizio": "string",
    "descrizione_servizio": "string",
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0,
    "quantita": 0
    }
  ]
},
"confirmed_timestamp": 0,
"id": "string"

}

Ottenere informazioni su una singola posta prioritaria

Authorizations:

bearerAuth

path Parameters

required

string

query Parameters

ricevuta	string Example: ricevuta=1 Se l'opzione è stata impostata, restituisce un file PDF come file ricevuto.
state	string Example: state=NEW Se l'opzione è stata impostata, restituisce uno schema specifico con uno stato uguale a quello richiesto.

Responses

Response Schema: application/json

	object
message	string
success	boolean
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/prioritarie/%7Bid%7D?ricevuta=1&state=NEW");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": {
- "mittente": {
  - "titolo": "mr",
  - "nome": "John",
  - "cognome": "Doe",
  - "dug": "Piazza",
  - "indirizzo": "Dante Alighieri",
  - "civico": "1",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "IT",
  - "email": "[email protected]"
  },
- "destinatari": [
  - {
    "titolo": "mr",
    "nome": "John",
    "cognome": "Doe",
    "dug": "Piazza",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    }
  ],
- "documento": [
  - "testo di prova"
  ],
- "opzioni": {
  - "fronteretro": false,
  - "colori": false,
  - "autoconfirm": true,
  - "callback_url": "https://example.com/webhooks",
  - "timestamp_invio": 1635168169
  },
- "prodotto": "ordinaria",
- "creation_timestamp": 1635168169,
- "update_timestamp": 1635168169,
- "username": "[email protected]",
- "confirmed": true,
- "state": "CONFIRMED",
- "documento_validato": {
  - "pdf": "https://ws.ufficiopostale.com/Up/pdf/test.pdf",
  - "jpg": "https://ws.ufficiopostale.com/Up/jpg/test.jpg",
  - "pagine": 1,
  - "size": 5249
  },
- "pricing": {
  - "dettaglio": [
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa Postale pagine",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.85,
    "importo_unitario_netto": 0.85,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0.20740000000000003,
    "importo_unitario_netto": 0.17,
    "importo_unitario_iva": 0.0374
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0.31720000000000004,
    "importo_unitario_netto": 0.26,
    "importo_unitario_iva": 0.0572
    }
    ],
  - "totale": {
    "importo_totale_netto": 1.28,
    "importo_totale_iva": 0.0946,
    "importo_totale": 1.3746
    }
  },
- "confirmed_timestamp": 1635168169,
- "id": "az034324hjksd829jwqlo12uo"
},
"message": "",
"success": true,
"error": null

}

Confermare l'invio di un messaggio creato con "aut

Confermare l'invio di un messaggio creato con "autoconfirm = false".

Authorizations:

bearerAuth

path Parameters

required

string

Request Body schema: application/json

confirmed

boolean

Responses

Request samples

Content type

application/json

{

"confirmed": true

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "titolo": "mr",
    "nome": "Lorenzo",
    "cognome": "Paderi",
    "dug": "Piazza",
    "indirizzo": "ener bettica",
    "civico": "43",
    "comune": "roma",
    "cap": "00121",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "titolo": "mr",
    "nome": "Lorenzo",
    "cognome": "Paderi",
    "dug": "Piazza",
    "indirizzo": "ener bettica",
    "civico": "43",
    "comune": "roma",
    "cap": "00121",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]",
    "id": "6499a05813df9dd7900e42c4",
    "state": "NEW"
    }
    ],
  - "documento": [
    "Lorem ipsum dixit nuovo test2"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": false,
    "autoconfirm": false,
    "ricevuta": true,
    "callback_url": "https://webhook.site/b1738747-6cd4-46b8-8ce4-784d03f051ce",
    "timestamp_invio": 1687789658
    },
  - "prodotto": "prioritaria",
  - "creation_timestamp": 1687789656,
  - "update_timestamp": 1687789674,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://alpha.ws.ufficiopostale.com/Up/pdf/prioritariaCukonJsUHfAJMObAd1WFFPGP7.pdf",
    "jpg": "https://alpha.ws.ufficiopostale.com/Up/jpg/prioritariaCukonJsUHfAJMObAd1WFFPGP7.jpg",
    "filename": "prioritariaCukonJsUHfAJMObAd1WFFPGP7.pdf",
    "pagine": 1,
    "size": 5273
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "RicevutaDiInvio",
    "descrizione_servizio": "Ricevuta Di Invio",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 1,
    "importo_unitario_netto": 1,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa postale pagine",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_netto": 2.1,
    "importo_unitario_iva": 0.462,
    "importo_unitario_totale": 2.5620000000000003
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_netto": 0.22,
    "importo_unitario_iva": 0.048400000000000006,
    "importo_unitario_totale": 0.2684
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_netto": 0.23,
    "importo_unitario_iva": 0.0506,
    "importo_unitario_totale": 0.2806
    }
    ],
    "totale": {
    "importo_totale_netto": 3.5500000000000003,
    "importo_totale_iva": 0.561,
    "importo_totale": 4.111000000000001
    }
    },
  - "confirmed_timestamp": 1687789674,
  - "id": "6499a05a13df9dd7900e42c5"
  }
],
"success": true,
"message": "",
"error": null

}

Posta Ordinaria

Elencate le vostre richieste

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
success	boolean
message	string
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/ordinarie/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Alberto",
    "cognome": "Rossi",
    "email": "[email protected]"
    },
  - "creation_timestamp": 1608040424,
  - "update_timestamp": 1608040424,
  - "confirmed": false,
  - "state": "NEW",
  - "id": "5fd8bfeaa10b340e2e558db7"
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Inviare una mail standard. Nel corpo del messaggio

Inviare una mail standard. Nel corpo del messaggio si devono fornire informazioni sul mittente e sul/i destinatario/i. Inoltre, il parametro "autoconfirm" può essere impostato a false per salvare la mail per una successiva conferma con una richiesta PATCH, mentre si esegue una logica personalizzata con la risposta.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
	object
	Array of Recipient (object) or Casella postale (object) (Recipient or Casella postale)
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.

Responses

Response Schema: application/json

	object
	object
	Array of objects
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.
	object (documento_validato) L'output del processo di generazione dei documenti.

Callbacks

Request samples

Content type

application/json

{

"mittente": {
- "titolo": "mr",
- "nome": "Mario",
- "cognome": "Rossi",
- "dug": "Via",
- "indirizzo": "Dante Alighieri",
- "civico": "1",
- "comune": "Roma",
- "cap": "00100",
- "provincia": "RM",
- "nazione": "Italia",
- "email": "[email protected]"
},
"destinatari": [
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "via",
  - "indirizzo": "Dante Alighieri",
  - "civico": "6",
  - "comune": "Roma",
  - "cap": "00101",
  - "provincia": "RE",
  - "nazione": "Italia"
  },
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "co": "OPENAPI SRL",
  - "dug": "piazza",
  - "indirizzo": "San Giovanni",
  - "civico": "6",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "Italia"
  }
],
"documento": [
- "Example document"
],
"opzioni": {
- "fronteretro": false,
- "colori": false,
- "ar": true,
- "autoconfirm": true
}

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "titolo": "mr",
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "Via",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "Roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "nome": "Mario",
    "cognome": "Rossi",
    "co": "OPENAPI SRL",
    "dug": "via",
    "indirizzo": "Dante Alighieri",
    "civico": "6",
    "comune": "Roma",
    "cap": "00101",
    "provincia": "RE",
    "nazione": "IT",
    "id": "6103f711dd2507415c5db6ce",
    "state": "NEW"
    },
    {
    "nome": "Mario",
    "cognome": "Rossi",
    "co": "OPENAPI SRL",
    "dug": "piazza",
    "indirizzo": "San Giovanni",
    "civico": "6",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "id": "6103f711dd2507415c5db6cf",
    "state": "NEW"
    }
    ],
  - "documento": [
    "Example document"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": false,
    "ar": {
    "titolo": "mr",
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "Via",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "Roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
    "autoconfirm": true,
    "timestamp_invio": 1627649810
    },
  - "prodotto": "raccomandata",
  - "creation_timestamp": 1627649809,
  - "update_timestamp": 1627649810,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf",
    "jpg": "https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg",
    "pagine": 1,
    "size": 9350
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "RicevutaRitorno",
    "descrizione_servizio": "Ricevuta di Ritorno",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0.8,
    "importo_unitario_netto": 0.8,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa Postale pagine",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 3.4,
    "importo_unitario_netto": 3.4,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0.1,
    "importo_unitario_netto": 0.1,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 0,
    "quantita": 2,
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0
    }
    ],
    "totale": {
    "importo_totale_netto": 8.6,
    "importo_totale_iva": 0,
    "importo_totale": 8.6
    }
    },
  - "lock": false,
  - "confirmed_timestamp": 1627649810,
  - "id": "6103f712dd2507415c5db6d0"
  }
],
"success": true,
"message": "",
"error": null

}

Callback payload samples

Callback

POST: {$request.body#/opzioni/callback_url}

Content type

application/json

{

"mittente": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string"
},
"destinatari": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string",
- "id": "string",
- "state": "string"
},
"documento": [
- "string"
],
"opzioni": {
- "fronteretro": true,
- "colori": true,
- "autoconfirm": true,
- "callback_url": "string",
- "timestamp_invio": 0
},
"prodotto": "string",
"creation_timestamp": 0,
"update_timestamp": 0,
"username": "string",
"confirmed": true,
"state": "string",
"documento_validato": {
- "pdf": "string",
- "jpg": "string",
- "filename": "string",
- "pagine": 0,
- "size": 0
},
"pricing": {
- "totale": {
  - "importo_totale": 0
  },
- "dettaglio": [
  - {
    "codice_servizio": "string",
    "descrizione_servizio": "string",
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0,
    "quantita": 0
    }
  ]
},
"confirmed_timestamp": 0,
"id": "string"

}

Ottenere informazioni su una singola mail

Authorizations:

bearerAuth

path Parameters

required

string

query Parameters

ricevuta	string Example: ricevuta=1 Se l'opzione è stata impostata, restituisce un file PDF come file ricevuto.
state	string Example: state=NEW Se l'opzione è stata impostata, restituisce uno schema specifico con uno stato uguale a quello richiesto.

Responses

Response Schema: application/json

	object
message	string
success	boolean
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/ordinarie/%7Bid%7D?ricevuta=1&state=NEW");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": {
- "mittente": {
  - "titolo": "mr",
  - "nome": "John",
  - "cognome": "Doe",
  - "dug": "Piazza",
  - "indirizzo": "Dante Alighieri",
  - "civico": "1",
  - "comune": "roma",
  - "cap": "00100",
  - "provincia": "RM",
  - "nazione": "IT",
  - "email": "[email protected]"
  },
- "destinatari": [
  - {
    "titolo": "mr",
    "nome": "John",
    "cognome": "Doe",
    "dug": "Piazza",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    }
  ],
- "documento": [
  - "testo di prova"
  ],
- "opzioni": {
  - "fronteretro": false,
  - "colori": false,
  - "autoconfirm": true,
  - "callback_url": "https://example.com/webhooks",
  - "timestamp_invio": 1635168169
  },
- "prodotto": "ordinaria",
- "creation_timestamp": 1635168169,
- "update_timestamp": 1635168169,
- "username": "[email protected]",
- "confirmed": true,
- "state": "CONFIRMED",
- "documento_validato": {
  - "pdf": "https://ws.ufficiopostale.com/Up/pdf/test.pdf",
  - "jpg": "https://ws.ufficiopostale.com/Up/jpg/test.jpg",
  - "pagine": 1,
  - "size": 5249
  },
- "pricing": {
  - "dettaglio": [
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa Postale pagine",
    "percentuale_iva": 0,
    "quantita": 1,
    "importo_unitario_totale": 0.85,
    "importo_unitario_netto": 0.85,
    "importo_unitario_iva": 0
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0.20740000000000003,
    "importo_unitario_netto": 0.17,
    "importo_unitario_iva": 0.0374
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0.31720000000000004,
    "importo_unitario_netto": 0.26,
    "importo_unitario_iva": 0.0572
    }
    ],
  - "totale": {
    "importo_totale_netto": 1.28,
    "importo_totale_iva": 0.0946,
    "importo_totale": 1.3746
    }
  },
- "confirmed_timestamp": 1635168169,
- "id": "az034324hjksd829jwqlo12uo"
},
"message": "",
"success": true,
"error": null

}

Confermare l'invio di un messaggio creato con "aut

Confermare l'invio di un messaggio creato con "autoconfirm = false".

Authorizations:

bearerAuth

path Parameters

required

string

Request Body schema: application/json

confirmed

boolean

Responses

Request samples

Content type

application/json

{

"confirmed": true

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "titolo": "mr",
    "nome": "Lorenzo",
    "cognome": "Paderi",
    "dug": "Piazza",
    "indirizzo": "ener bettica",
    "civico": "1",
    "comune": "roma",
    "cap": "00121",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]"
    },
  - "destinatari": [
    {
    "titolo": "mr",
    "nome": "Lorenzo",
    "cognome": "Paderi",
    "dug": "Piazza",
    "indirizzo": "ener bettica",
    "civico": "11",
    "comune": "roma",
    "cap": "00121",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]",
    "id": "64999de413df9dd7900e42c0",
    "state": "NEW"
    }
    ],
  - "documento": [
    "https://www.nasa.gov/pdf/65431main_ffs_factsheets_issoverview.pdf",
    "https://www.nasa.gov/pdf/65431main_ffs_factsheets_issoverview.pdf"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": true,
    "autoconfirm": false,
    "callback_url": "https://webhook.site/b1738747-6cd4-46b8-8ce4-784d03f051ce",
    "timestamp_invio": 1687789031
    },
  - "prodotto": "ordinaria",
  - "creation_timestamp": 1687789028,
  - "update_timestamp": 1687789043,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://alpha.ws.ufficiopostale.com/Up/pdf/ordinariaZTq31xBfGVtjo4YxQJzSrvNRb.pdf",
    "jpg": "https://alpha.ws.ufficiopostale.com/Up/jpg/ordinariaZTq31xBfGVtjo4YxQJzSrvNRb.jpg",
    "filename": "ordinariaZTq31xBfGVtjo4YxQJzSrvNRb.pdf",
    "pagine": 4,
    "size": 149658
    },
  - "pricing": {
    "dettaglio": [
    {
    "codice_servizio": "StampaColori",
    "descrizione_servizio": "Stampa Colori",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_totale": 0.8539999999999999,
    "importo_unitario_netto": 0.7,
    "importo_unitario_iva": 0.15399999999999997
    },
    {
    "codice_servizio": "pagine",
    "descrizione_servizio": "Tariffa postale pagine",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_netto": 0.95,
    "importo_unitario_iva": 0.209,
    "importo_unitario_totale": 1.159
    },
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_netto": 0.4,
    "importo_unitario_iva": 0.088,
    "importo_unitario_totale": 0.488
    },
    {
    "codice_servizio": "IMBUST",
    "descrizione_servizio": "Imbustamento",
    "percentuale_iva": 22,
    "quantita": 1,
    "importo_unitario_netto": 0.14,
    "importo_unitario_iva": 0.030800000000000004,
    "importo_unitario_totale": 0.1708
    }
    ],
    "totale": {
    "importo_totale_netto": 2.19,
    "importo_totale_iva": 0.48179999999999995,
    "importo_totale": 2.6717999999999997
    }
    },
  - "confirmed_timestamp": 1687789043,
  - "id": "64999de713df9dd7900e42c1"
  }
],
"success": true,
"message": "",
"error": null

}

Raccomandata Smart

Elenca il tuo raccomandato_smart

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
message	string
success	boolean
error	any

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/raccomandate_smart/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "ragione_sociale": "openapi srl",
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi"
    },
  - "creation_timestamp": 1657169682,
  - "update_timestamp": 1676901090,
  - "confirmed": false,
  - "state": "SENT",
  - "id": "xxxxxxxe557d71a5b600ee11d"
  }
],
"message": "1 Risultati",
"success": true,
"error": null

}

Inviare una Raccomandata Smart. Nel corpo del mess

Inviare una Raccomandata Smart. Nel corpo del messaggio si devono fornire informazioni sul mittente e sul/i destinatario/i. Inoltre, il parametro "autoconfirm" può essere impostato su false per conservarlo per una successiva conferma con una richiesta PATCH, mentre si esegue una logica personalizzata con la risposta.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
	object
	Array of Recipient (object) or Casella postale (object) (Recipient or Casella postale)
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	integer

Callbacks

Request samples

Content type

application/json

{

"mittente": [
- {
  - "ragione_sociale": "Openapi SRL",
  - "civico": "221",
  - "comune": "roma",
  - "dug": "via",
  - "indirizzo": "Filippo tommaso marinetti",
  - "cap": "00143",
  - "provincia": "RM",
  - "nazione": "IT",
  - "email": "[email protected]"
  }
],
"destinatari": [
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "dug": "via",
  - "indirizzo": "Dante Alighieri",
  - "civico": "6",
  - "comune": "Roma",
  - "cap": "00143",
  - "provincia": "RM",
  - "nazione": "Italia"
  }
],
"documento": [
- "https://www.soundczech.cz/temp/lorem-ipsum.pdf"
],
"opzioni": {
- "fronteretro": false,
- "colori": false,
- "ar": true,
- "autoconfirm": false,
- "callback_url": "https://webhook.site/65639a84-77cb-42f2-a621-394921770497"
}

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "ragione_sociale": "Openapi SRL",
    "civico": "221",
    "comune": "roma",
    "dug": "via",
    "indirizzo": "Filippo tommaso marinetti",
    "cap": "00143",
    "provincia": "RM",
    "nazione": "IT",
    "email": "[email protected]",
    "intestazione_completa": "Mario Rossi"
    },
  - "destinatari": {
    "nome": "Mario",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "Dante Alighieri",
    "civico": "6",
    "comune": "Roma",
    "cap": "00143",
    "provincia": "RM",
    "nazione": "Italia",
    "intestazione_completa": "Mario Rossi",
    "zona": "AM",
    "id": "xxxxxxxe557d71a5b600ee17d",
    "state": "NEW"
    },
  - "documento": [
    "https://www.soundczech.cz/temp/lorem-ipsum.pdf"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": false,
    "ar": true,
    "autoconfirm": false,
    "callback_url": "https://webhook.site/65639a84-77cb-42f2-a621-394921770497"
    },
  - "prodotto": "raccomandata_smart",
  - "creation_timestamp": 1687169678,
  - "update_timestamp": 1687169682,
  - "username": "[email protected]",
  - "confirmed": false,
  - "state": "NEW",
  - "documento_validato": {
    "pdf": "https://test.ws.ufficiopostale.com/Up/pdf/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf",
    "jpg": "https://test.ws.ufficiopostale.com/Up/jpg/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.jpg",
    "filename": "raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf",
    "pagine": 2,
    "size": 49553,
    "pricing": {
    "totale": {
    "importo_totale": 0.58
    },
    "dettaglio": [
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "importo_unitario_totale": 0.28,
    "importo_unitario_netto": 0.22,
    "importo_unitario_iva": 0.06,
    "quantita": 1
    },
    {
    "codice_servizio": "spedizione",
    "descrizione_servizio": "Spedizione",
    "importo_unitario_totale": 0.3,
    "importo_unitario_netto": 0.3,
    "importo_unitario_iva": 0,
    "quantita": 1
    }
    ]
    },
    "id": "xxxxxxxe557d71a5b600ee13d"
    }
  }
],
"success": true,
"message": "",
"error": null

}

Callback payload samples

Callback

POST: {$request.body#/opzioni/callback_url}

Content type

application/json

{

"mittente": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string"
},
"destinatari": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string",
- "id": "string",
- "state": "string"
},
"documento": [
- "string"
],
"opzioni": {
- "fronteretro": true,
- "colori": true,
- "autoconfirm": true,
- "callback_url": "string",
- "timestamp_invio": 0
},
"prodotto": "string",
"creation_timestamp": 0,
"update_timestamp": 0,
"username": "string",
"confirmed": true,
"state": "string",
"documento_validato": {
- "pdf": "string",
- "jpg": "string",
- "filename": "string",
- "pagine": 0,
- "size": 0
},
"pricing": {
- "totale": {
  - "importo_totale": 0
  },
- "dettaglio": [
  - {
    "codice_servizio": "string",
    "descrizione_servizio": "string",
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0,
    "quantita": 0
    }
  ]
},
"confirmed_timestamp": 0,
"id": "string"

}

Elenca la tua raccomandata singola intelligente

Authorizations:

bearerAuth

path Parameters

required

string

query Parameters

state

string

Example: state=NEW

Se l'opzione è stata impostata, restituisce uno schema specifico con uno stato uguale a quello richiesto.

Responses

Response Schema: application/json

	object (ExampleState)
	object
success	boolean
message	string
error	integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/raccomandate_smart/%7Bid%7D?state=NEW");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "ener bettica",
    "civico": "14",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi"
    },
  - "destinatari": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "lazio",
    "civico": "12",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi",
    "id": "xxxxxxxe557d71a5b600ee17d",
    "state": "NEW"
    },
  - "documento": [
    "test prova"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": true,
    "autoconfirm": true,
    "callback_url": "https://webhook.site/b1738747-6cd4-46b8-8ce4-784d03f051ce",
    "timestamp_invio": 1687169681
    },
  - "prodotto": "raccomandata_smart",
  - "creation_timestamp": 1687169678,
  - "update_timestamp": 1687169682,
  - "username": "[email protected]",
  - "confirmed": false,
  - "state": "NEW",
  - "documento_validato": {
    "pdf": "https://test.ws.ufficiopostale.com/Up/pdf/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf",
    "jpg": "https://test.ws.ufficiopostale.com/Up/jpg/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.jpg",
    "filename": "raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf",
    "pagine": 2,
    "size": 49553,
    "pricing": {
    "totale": {
    "importo_totale": 0.58
    },
    "dettaglio": [
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "importo_unitario_totale": 0.28,
    "importo_unitario_netto": 0.22,
    "importo_unitario_iva": 0.06,
    "quantita": 1
    },
    {
    "codice_servizio": "spedizione",
    "descrizione_servizio": "Spedizione",
    "importo_unitario_totale": 0.3,
    "importo_unitario_netto": 0.3,
    "importo_unitario_iva": 0,
    "quantita": 1
    }
    ]
    },
    "id": "xxxxxxxe557d71a5b600ee13d"
    }
  }
],
"success": true,
"message": "",
"error": null

}

Confermare l'invio di un messaggio creato con "aut

Confermare l'invio di un messaggio creato con "autoconfirm = false".

Authorizations:

bearerAuth

path Parameters

required

string

Request Body schema: application/json

confirmed

boolean

Responses

Request samples

Content type

application/json

{

"confirmed": true

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "romagna",
    "civico": "12",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi"
    },
  - "destinatari": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "alighieri",
    "civico": "15",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi",
    "id": "xxxxxxxe557d71a5b600ee17d",
    "state": "NEW"
    },
  - "documento": [
    "test prova"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": true,
    "autoconfirm": true,
    "callback_url": "https://webhook.site/b1738747-6cd4-46b8-8ce4-784d03f051ce",
    "timestamp_invio": 1687169681
    },
  - "prodotto": "raccomandata_smart",
  - "creation_timestamp": 1687169678,
  - "update_timestamp": 1687169682,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://test.ws.ufficiopostale.com/Up/pdf/raccomandata_smartyvSPArFg2S7ccrrK99YIuyItJ.pdf",
    "jpg": "https://test.ws.ufficiopostale.com/Up/jpg/raccomandata_smartyvSPArFg2S7ccrrK99YIuyItJ.jpg",
    "filename": "raccomandata_smartyvSPArFg2S7ccrrK99YIuyItJ.pdf",
    "pagine": 1,
    "size": 6840,
    "pricing": {
    "totale": {
    "importo_totale": 2.2
    },
    "dettaglio": [
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "importo_unitario_totale": 0.29,
    "importo_unitario_netto": 0.23,
    "importo_unitario_iva": 0.06,
    "quantita": 1
    },
    {
    "codice_servizio": "spedizione",
    "descrizione_servizio": "spedizione",
    "importo_unitario_totale": 1.91,
    "importo_unitario_netto": 1.91,
    "importo_unitario_iva": 0,
    "quantita": 1
    }
    ]
    },
    "confirmed_timestamp": "1687169682,",
    "id": "xxxxxxxe557d71a5b600ee13d"
    }
  }
],
"success": true,
"message": "",
"error": null

}

Posta Massiva

Elenca la tua posta_massiva

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of objects
message	string
success	boolean
error	integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/posta_massiva/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi"
    },
  - "creation_timestamp": 1657169682,
  - "update_timestamp": 1676901090,
  - "confirmed": false,
  - "state": "SENT",
  - "id": "xxxxxxxe557d71a5b600ee11d"
  },
- {
  - "mittente": {
    "nome": "Fabio",
    "email": "[email protected]",
    "cognome": "verdi"
    },
  - "creation_timestamp": 1657169682,
  - "update_timestamp": 1676901090,
  - "confirmed": false,
  - "state": "NEW",
  - "id": "xxxxxxxe557d71a5b600ee14d"
  },
- {
  - "mittente": {
    "nome": "Sara",
    "email": "[email protected]",
    "cognome": "Rossi"
    },
  - "creation_timestamp": 1657169682,
  - "update_timestamp": 1676901090,
  - "confirmed": false,
  - "state": "NEW",
  - "id": "xxxxxxxe557d71a5b6005e13d"
  }
],
"message": "3 Risultati",
"success": true,
"error": null

}

Inviare una posta_massiva. Nel corpo del post si d

Inviare una posta_massiva. Nel corpo del post si devono fornire informazioni sul mittente e sul/i destinatario/i. Inoltre, il parametro "autoconfirm" può essere impostato a false, per conservarlo per una successiva conferma con una richiesta PATCH, mentre si esegue una logica personalizzata con la risposta.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
	object
	Array of Recipient (object) or Casella postale (object) (Recipient or Casella postale)
	Array of strings or string (documento) Il documento può essere una stringa o un array di stringhe in testo normale. Le stringhe possono essere: Testo normale Formattato in HTML, con stile, tag di intestazione ecc. Un URL che punta a una pagina web, a un PDF o a un file immagine (gli URL devono iniziare con http). Il contenuto è dedotto dall'intestazione "Content-Type" . Un file PDF codificato in base64. Le stringhe codificate sono dedotte dall'intestazione del contenuto base64 data:application/pdf;base64,: in pratica, per contrassegnare una stringa come contenuto codificato in base64, si deve anteporre la stringa suddetta all'output. La richiesta restituirà un errore se il processo di decodifica fallisce sul server . Il servizio analizza il campo "documento", unisce tutte le stringhe/documenti/immagini in pagine diverse, comprime leggermente (se possibile) e genera un unico file PDF. La dimensione massima di un documento PDF, dopo la nostra compressione, è di 5 MB per tutti i prodotti ad eccezione di Posta 4 PRO, Posta Massiva e Raccomandata Smart (questi 3 prodotti accettano fino a un massimo di 15 MB). Il numero massimo di pagine è attualmente 50, o 100 se si utilizza l'opzione fronteretro.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	integer

Callbacks

Request samples

Content type

application/json

{

"mittente": {
- "nome": "Mario",
- "cognome": "Rossi",
- "dug": "Via",
- "indirizzo": "Dante Alighieri",
- "civico": "1",
- "comune": "Roma",
- "cap": "00100",
- "provincia": "RM",
- "nazione": "Italia",
- "email": "[email protected]"
},
"destinatari": [
- {
  - "nome": "Mario",
  - "cognome": "Rossi",
  - "dug": "via",
  - "indirizzo": "Morandi",
  - "civico": "6",
  - "comune": "Roma",
  - "cap": "00101",
  - "provincia": "RM",
  - "nazione": "Italia"
  }
],
"documento": [
- "Example document"
],
"opzioni": {
- "fronteretro": false,
- "colori": false,
- "autoconfirm": false
}

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "Dante Alighieri",
    "civico": "1",
    "comune": "Roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi"
    },
  - "destinatari": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "Morandi",
    "civico": "6",
    "comune": "Roma",
    "cap": "00101",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi",
    "id": "xxxxxxxe557d71a5b600ee17d",
    "state": "NEW"
    },
  - "documento": [
    "Example document"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": true,
    "autoconfirm": false
    },
  - "prodotto": "posta_massiva",
  - "creation_timestamp": 1687169678,
  - "update_timestamp": 1687169682,
  - "username": "[email protected]",
  - "confirmed": false,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://test.ws.ufficiopostale.com/Up/pdf/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf",
    "jpg": "https://test.ws.ufficiopostale.com/Up/jpg/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.jpg",
    "filename": "posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf",
    "pagine": 1,
    "size": 6849,
    "pricing": {
    "totale": {
    "importo_totale": 0.74
    },
    "dettaglio": [
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "importo_unitario_totale": 0.29,
    "importo_unitario_netto": 0.23,
    "importo_unitario_iva": 0.06,
    "quantita": 1
    },
    {
    "codice_servizio": "spedizione",
    "descrizione_servizio": "Spedizione",
    "importo_unitario_totale": 0.45,
    "importo_unitario_netto": 0.45,
    "importo_unitario_iva": 0,
    "quantita": 1
    }
    ]
    },
    "id": "xxxxxxxe557d71a5b600ee13d"
    }
  }
],
"success": true,
"message": "",
"error": null

}

Callback payload samples

Callback

POST: {$request.body#/opzioni/callback_url}

Content type

application/json

{

"mittente": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string"
},
"destinatari": {
- "nome": "string",
- "email": "string",
- "cognome": "string",
- "dug": "string",
- "indirizzo": "string",
- "civico": "string",
- "comune": "string",
- "cap": 0,
- "provincia": "string",
- "nazione": "string",
- "intestazione_completa": "string",
- "id": "string",
- "state": "string"
},
"documento": [
- "string"
],
"opzioni": {
- "fronteretro": true,
- "colori": true,
- "autoconfirm": true,
- "callback_url": "string",
- "timestamp_invio": 0
},
"prodotto": "string",
"creation_timestamp": 0,
"update_timestamp": 0,
"username": "string",
"confirmed": true,
"state": "string",
"documento_validato": {
- "pdf": "string",
- "jpg": "string",
- "filename": "string",
- "pagine": 0,
- "size": 0
},
"pricing": {
- "totale": {
  - "importo_totale": 0
  },
- "dettaglio": [
  - {
    "codice_servizio": "string",
    "descrizione_servizio": "string",
    "importo_unitario_totale": 0,
    "importo_unitario_netto": 0,
    "importo_unitario_iva": 0,
    "quantita": 0
    }
  ]
},
"confirmed_timestamp": 0,
"id": "string"

}

Elenca il tuo singolo posta_massiva

Authorizations:

bearerAuth

path Parameters

required

string

query Parameters

state

string

Example: state=NEW

Se l'opzione è stata impostata, restituisce uno schema specifico con uno stato uguale a quello richiesto.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/posta_massiva/%7Bid%7D?state=NEW");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "trastevere",
    "civico": "8",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi"
    },
  - "destinatari": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "ener bettica",
    "civico": "7",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi",
    "id": "xxxxxxxe557d71a5b600ee17d",
    "state": "NEW"
    },
  - "documento": [
    "test prova"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": true,
    "autoconfirm": true,
    "callback_url": "https://webhook.site/b1738747-6cd4-46b8-8ce4-784d03f051ce",
    "timestamp_invio": 1687169681
    },
  - "prodotto": "posta_massiva",
  - "creation_timestamp": 1687169678,
  - "update_timestamp": 1687169682,
  - "username": "[email protected]",
  - "confirmed": false,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://test.ws.ufficiopostale.com/Up/pdf/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf",
    "jpg": "https://test.ws.ufficiopostale.com/Up/jpg/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.jpg",
    "filename": "posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf",
    "pagine": 1,
    "size": 6849,
    "pricing": {
    "totale": {
    "importo_totale": 0.74
    },
    "dettaglio": [
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "importo_unitario_totale": 0.29,
    "importo_unitario_netto": 0.23,
    "importo_unitario_iva": 0.06,
    "quantita": 1
    },
    {
    "codice_servizio": "spedizione",
    "descrizione_servizio": "Spedizione",
    "importo_unitario_totale": 0.45,
    "importo_unitario_netto": 0.45,
    "importo_unitario_iva": 0,
    "quantita": 1
    }
    ]
    },
    "id": "xxxxxxxe557d71a5b600ee13d"
    }
  }
],
"success": true,
"message": "",
"error": null

}

Confermare l'invio di un messaggio creato con "aut

Confermare l'invio di un messaggio creato con "autoconfirm = false".

Authorizations:

bearerAuth

path Parameters

required

string

Request Body schema: application/json

confirmed

boolean

Responses

Request samples

Content type

application/json

{

"confirmed": true

}

Response samples

Content type

application/json

{

"data": [
- {
  - "mittente": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "ener bettica",
    "civico": "7",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi"
    },
  - "destinatari": {
    "nome": "Mario",
    "email": "[email protected]",
    "cognome": "Rossi",
    "dug": "via",
    "indirizzo": "umbria",
    "civico": "10",
    "comune": "roma",
    "cap": "00100",
    "provincia": "RM",
    "nazione": "IT",
    "intestazione_completa": "Mario Rossi",
    "id": "xxxxxxxe557d71a5b600ee17d",
    "state": "NEW"
    },
  - "documento": [
    "test prova"
    ],
  - "opzioni": {
    "fronteretro": false,
    "colori": true,
    "autoconfirm": true,
    "callback_url": "https://webhook.site/b1738747-6cd4-46b8-8ce4-784d03f051ce",
    "timestamp_invio": 1687169681
    },
  - "prodotto": "posta_massiva",
  - "creation_timestamp": 1687169678,
  - "update_timestamp": 1687169682,
  - "username": "[email protected]",
  - "confirmed": true,
  - "state": "CONFIRMED",
  - "documento_validato": {
    "pdf": "https://test.ws.ufficiopostale.com/Up/pdf/posta_massivayvSPArFg2S7ccrrK99YIuyItJ.pdf",
    "jpg": "https://test.ws.ufficiopostale.com/Up/jpg/posta_massivayvSPArFg2S7ccrrK99YIuyItJ.jpg",
    "filename": "posta_massivayvSPArFg2S7ccrrK99YIuyItJ.pdf",
    "pagine": 1,
    "size": 6840,
    "pricing": {
    "totale": {
    "importo_totale": 2.2
    },
    "dettaglio": [
    {
    "codice_servizio": "STAMPA",
    "descrizione_servizio": "Costo Stampa",
    "importo_unitario_totale": 0.29,
    "importo_unitario_netto": 0.23,
    "importo_unitario_iva": 0.06,
    "quantita": 1
    },
    {
    "codice_servizio": "spedizione",
    "descrizione_servizio": "spedizione",
    "importo_unitario_totale": 1.91,
    "importo_unitario_netto": 1.91,
    "importo_unitario_iva": 0,
    "quantita": 1
    }
    ]
    },
    "confirmed_timestamp": "1687169682,",
    "id": "xxxxxxxe557d71a5b600ee13d"
    }
  }
],
"success": true,
"message": "",
"error": null

}

Web Service Revision: 2.0.0