Ufficio Postale

  1. Home
  2. Libreria API
  3. Ufficio Postale
Tutte le tue spedizioni tramite API ed in tempo reale

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

Tutte le informazioni di cui hai bisogno

Qui trovi qualche consiglio da prendere in considerazione per approcciare a questa API. Se preferisci forniamo esempi di codice, documentazione in OAS3, la possibilità di provare l'API dal vivo con la Swagger UI oppure importare l'intera collezione in Postman. Offriamo inoltre un ambiente di Sandbox dove puoi sperimentare tutte le API gratuitamente.

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.
Approfondisci Oauth Gestisci i tokens

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.
Approfondisci Oauth Gestisci i tokens
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

  1. Creare una nuova mail con una richiesta POST
  2. Controllare i prezzi e confermarli con un PATCH, oppure utilizzare autoconfirm: true
  3. 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

OK

{
  • "data": [
    ],
  • "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": [
    ],
  • "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": [
    ],
  • "message": "1 Risultato",
  • "success": true,
  • "error": null
}

Traccia il tuo prodotto

Authorizations:
bearerAuth
path Parameters
id
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": [
    ],
  • "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

OK

{
  • "data": [
    ],
  • "message": "1 Risultati",
  • "success": true,
  • "error": null
}

Telegrammi

Ottenere informazioni su un telegramma

Authorizations:
bearerAuth
path Parameters
id
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": {
    },
  • "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
id
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": [
    ],
  • "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": [
    ],
  • "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": {
    },
  • "destinatari": [
    ],
  • "documento": [
    ],
  • "opzioni": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/opzioni/callback_url}
Content type
application/json
{
  • "mittente": {
    },
  • "destinatari": {
    },
  • "documento": [
    ],
  • "opzioni": {
    },
  • "prodotto": "string",
  • "creation_timestamp": 0,
  • "update_timestamp": 0,
  • "username": "string",
  • "confirmed": true,
  • "state": "string",
  • "documento_validato": {
    },
  • "pricing": {
    },
  • "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": [
    ],
  • "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": {
    },
  • "destinatari": [
    ],
  • "documento": [
    ],
  • "opzioni": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/opzioni/callback_url}
Content type
application/json
{
  • "mittente": {
    },
  • "destinatari": {
    },
  • "documento": [
    ],
  • "opzioni": {
    },
  • "prodotto": "string",
  • "creation_timestamp": 0,
  • "update_timestamp": 0,
  • "username": "string",
  • "confirmed": true,
  • "state": "string",
  • "documento_validato": {
    },
  • "pricing": {
    },
  • "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
id
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": {
    },
  • "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
id
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": [
    ],
  • "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": [
    ],
  • "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": {
    },
  • "destinatari": [
    ],
  • "documento": [
    ],
  • "opzioni": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/opzioni/callback_url}
Content type
application/json
{
  • "mittente": {
    },
  • "destinatari": {
    },
  • "documento": [
    ],
  • "opzioni": {
    },
  • "prodotto": "string",
  • "creation_timestamp": 0,
  • "update_timestamp": 0,
  • "username": "string",
  • "confirmed": true,
  • "state": "string",
  • "documento_validato": {
    },
  • "pricing": {
    },
  • "confirmed_timestamp": 0,
  • "id": "string"
}

Ottenere informazioni su una singola posta prioritaria

Authorizations:
bearerAuth
path Parameters
id
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": {
    },
  • "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
id
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": [
    ],
  • "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": [
    ],
  • "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": {
    },
  • "destinatari": [
    ],
  • "documento": [
    ],
  • "opzioni": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/opzioni/callback_url}
Content type
application/json
{
  • "mittente": {
    },
  • "destinatari": {
    },
  • "documento": [
    ],
  • "opzioni": {
    },
  • "prodotto": "string",
  • "creation_timestamp": 0,
  • "update_timestamp": 0,
  • "username": "string",
  • "confirmed": true,
  • "state": "string",
  • "documento_validato": {
    },
  • "pricing": {
    },
  • "confirmed_timestamp": 0,
  • "id": "string"
}

Ottenere informazioni su una singola mail

Authorizations:
bearerAuth
path Parameters
id
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": {
    },
  • "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
id
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": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Raccomandata Smart

Elenca il tuo raccomandato_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": [
    ],
  • "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": [
    ],
  • "destinatari": [
    ],
  • "documento": [],
  • "opzioni": {}
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/opzioni/callback_url}
Content type
application/json
{
  • "mittente": {
    },
  • "destinatari": {
    },
  • "documento": [
    ],
  • "opzioni": {
    },
  • "prodotto": "string",
  • "creation_timestamp": 0,
  • "update_timestamp": 0,
  • "username": "string",
  • "confirmed": true,
  • "state": "string",
  • "documento_validato": {
    },
  • "pricing": {
    },
  • "confirmed_timestamp": 0,
  • "id": "string"
}

Elenca la tua raccomandata singola intelligente

Elenca la tua raccomandata singola intelligente

Authorizations:
bearerAuth
path Parameters
id
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": [
    ],
  • "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
id
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": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Posta Massiva

Elenca la tua 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": [
    ],
  • "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": {
    },
  • "destinatari": [
    ],
  • "documento": [
    ],
  • "opzioni": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/opzioni/callback_url}
Content type
application/json
{
  • "mittente": {
    },
  • "destinatari": {
    },
  • "documento": [
    ],
  • "opzioni": {
    },
  • "prodotto": "string",
  • "creation_timestamp": 0,
  • "update_timestamp": 0,
  • "username": "string",
  • "confirmed": true,
  • "state": "string",
  • "documento_validato": {
    },
  • "pricing": {
    },
  • "confirmed_timestamp": 0,
  • "id": "string"
}

Elenca il tuo singolo posta_massiva

Elenca il tuo singolo posta_massiva

Authorizations:
bearerAuth
path Parameters
id
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": [
    ],
  • "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
id
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": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}
Web Service Revision: 2.0.0