Service postal

  1. Home
  2. Bibliothèque d'API
  3. Service postal
Tous vos envois via API et en temps réel

Automatisez l'envoi de documents, de recommandés, de télégrammes, de publicité avec la Poste

Toutes les connaissances dont vous avez besoin

Vous trouverez ici quelques conseils à prendre en compte pour aborder cette API. Si vous préférez, nous fournissons des exemples de code, la documentation OAS3, la possibilité d'essayer l'API en direct via Swagger UI ou d'importer l'intégralité de la collection dans Postman. Nous proposons également un environnement Sandbox où vous pouvez expérimenter toutes sortes de requêtes de manière totalement gratuite.

Conseils utiles pour commencer Service postal

Obtenir le Token dans la section appropriée avant de commencer.

Utilisez l'outil en ligne ou générez-le via l'API. Définissez la date d'expiration, un nom utile et ajoutez maintenant un ensemble d'étendues pour limiter les actions possibles que votre jeton peut effectuer.
En savoir plus sur l'API oauth Gérer mes jetons
API docs by Redocly

Ufficio Postale (1.0.0)

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

Ce service web permet la livraison de produits postaux tels que Raccomandate, Telegrammi, Posta Prioritaria par Poste Italiane

  1. Créer un nouveau courrier avec une requête POST
  2. Vérifier les prix et les confirmer avec un PATCH, ou utiliser autoconfirm : true
  4. Recevoir les mises à jour de l'état de votre courrier en fournissant une callback url

Note : Il existe certaines limitations concernant la taille d'un document PDF. Veuillez lire le champ "document" dans la description du point de terminaison que vous souhaitez utiliser.

Gestion des erreurs

Lorsqu'une erreur d'envoi se produit, la réponse comprendra un message et un data.wrong_fields : [] : chaque élément de wrong_fields est une chaîne de caractères qui indique l'origine de l'erreur. Cela facilite l'intégration dans votre formulaire frontal, où vous pouvez mettre en évidence les entrées erronées

Test

Lorsque vous utilisez l'environnement Sandbox, vous recevrez des rappels de mise à jour peu de temps après la création de la demande avec un contenu de type placeholder. Il est également possible, pour certains produits, de forcer l'exécution du rappel dans l'environnement sandbox.

C'est la première fois que vous venez ici ? Générer un nouveau jeton d'accès

Ufficio Postale

Obtenir des prix

Renvoie une liste de prix pour différents types de services

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
}

Liste d'adresses

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
}

Liste de tous les dugs disponibles

(désignations urbaines génériques)

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
}

Suivre votre produit

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
}

Obtenir des informations sur un code postal 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

Obtenir des informations sur un télégramme

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
ricevuta
string
Example: ricevuta=1

Si l'option a été définie, renvoie un fichier PDF en tant que fichier reçu.

state
string
Example: state=NEW

Si l'option a été définie, elle renvoie un schéma spécifique dont l'état est égal à celui demandé.

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
}

Confirmer l'envoi d'un télégramme

Confirmer l'envoi d'un télégramme qui a été créé avec "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
}

Liste des télégrammes

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
}

Envoyez un télégramme. Vous devez fournir des info

Envoyez un télégramme. Vous devez fournir des informations sur l'expéditeur et le(s) destinataire(s) dans le corps du message. En outre, le paramètre "autoconfirmation" peut être défini sur false pour enregistrer le télégramme en vue d'une confirmation ultérieure avec une demande PATCH, pendant que vous effectuez une logique personnalisée avec la réponse.

Authorizations:
bearerAuth
Request Body schema: application/json
object
object
Array of objects (Recipient)
Array of strings or string (documento)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

Responses

Response Schema: application/json
object
object
Array of objects
Array of strings or string (documento)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

object (documento_validato)

Le résultat du processus de génération de documents.

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

Ce produit offre un code de suivi

Inscrivez votre Raccomandate

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
}

Envoyez un Raccomandata. Vous devez fournir des in

Envoyez un Raccomandata. Vous devez fournir des informations sur l'expéditeur et le(s) destinataire(s) dans le corps du message. De plus, le paramètre "autoconfirm" peut être mis à faux pour sauvegarder les Raccomandata pour une confirmation ultérieure avec une requête PATCH, pendant que vous faites de la logique personnalisée avec la réponse. Vérifiez le champ NumeroRaccomandata dans l'objet destinataire si vous avez besoin du numéro de suivi.

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)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

Responses

Response Schema: application/json
object
object
Array of objects
Array of strings or string (documento)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

object (documento_validato)

Le résultat du processus de génération de documents.

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"
}

Obtenir des informations sur une Raccomandata

Vérifiez le champ NumeroRaccomandata dans l'objet destinataire si vous avez besoin du numéro de suivi.

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
ricevuta
string
Example: ricevuta=1

Si l'option a été définie, renvoie un fichier PDF en tant que fichier reçu.

state
string
Example: state=NEW

Si l'option a été définie, elle renvoie un schéma spécifique dont l'état est égal à celui demandé.

callback
string
Example: callback=<empty string>

Simule la progression du statut de l'envoi : A chaque fois que ce point d'accès est appelé, votre demande progresse jusqu'au statut d'expédition suivant Si vous le spécifiez dans la demande, vous recevrez des mises à jour par rappel.
Veuillez noter que cette option n'est disponible que pour l'environnement 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
}

Confirmer l'envoi d'une Raccomandata qui a été cré

Confirmer l'envoi d'une Raccomandata qui a été créée avec "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

Ce produit offre un code permettant de suivre les mises à jour de l'état d'avancement

Liste de vos demandes

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
}

Envoyez un courrier prioritaire. Vous devez fourni

Envoyez un courrier prioritaire. Vous devez fournir des informations sur l'expéditeur et le(s) destinataire(s) dans le corps du message. En outre, le paramètre "autoconfirmation" peut être défini sur false pour enregistrer le courrier en vue d'une confirmation ultérieure avec une demande PATCH, pendant que vous effectuez une logique personnalisée avec la réponse. Vérifiez le champ IdRicevuta dans l'objet destinataire si vous avez besoin du numéro de suivi.

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)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

Responses

Response Schema: application/json
object
object
Array of objects
Array of strings or string (documento)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

object (documento_validato)

Le résultat du processus de génération de documents.

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"
}

Obtenir des informations sur un courrier prioritaire unique

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
ricevuta
string
Example: ricevuta=1

Si l'option a été définie, renvoie un fichier PDF en tant que fichier reçu.

state
string
Example: state=NEW

Si l'option a été définie, elle renvoie un schéma spécifique dont l'état est égal à celui demandé.

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
}

Confirmer l'envoi d'un courrier qui a été créé ave

Confirmer l'envoi d'un courrier qui a été créé avec "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

Liste de vos demandes

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
}

Envoyez un courrier standard. Vous devez fournir d

Envoyez un courrier standard. Vous devez fournir des informations sur l'expéditeur et le(s) destinataire(s) dans le corps du message. En outre, le paramètre "autoconfirmation" peut être défini sur false pour enregistrer le courrier en vue d'une confirmation ultérieure avec une demande PATCH, pendant que vous effectuez une logique personnalisée avec la réponse.

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)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

Responses

Response Schema: application/json
object
object
Array of objects
Array of strings or string (documento)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option fronteretro.

object (documento_validato)

Le résultat du processus de génération de documents.

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"
}

Obtenir des informations sur un seul courrier

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
ricevuta
string
Example: ricevuta=1

Si l'option a été définie, renvoie un fichier PDF en tant que fichier reçu.

state
string
Example: state=NEW

Si l'option a été définie, elle renvoie un schéma spécifique dont l'état est égal à celui demandé.

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
}

Confirmer l'envoi d'un courrier qui a été créé ave

Confirmer l'envoi d'un courrier qui a été créé avec "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

Listez votre raccomandate_smart

Listez votre raccomandate_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
}

Envoyez un Raccomandata Smart. Vous devez fournir

Envoyez un Raccomandata Smart. Vous devez fournir des informations sur l'expéditeur et le(s) destinataire(s) dans le corps du message. De plus, le paramètre "autoconfirmation" peut être mis à faux pour le sauvegarder en vue d'une confirmation ultérieure avec une requête PATCH, pendant que vous faites de la logique personnalisée avec la réponse.

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)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option 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"
}

Listez votre single raccomandata smart

Listez votre single raccomandata smart

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
state
string
Example: state=NEW

Si l'option a été définie, elle renvoie un schéma spécifique dont l'état est égal à celui demandé.

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
}

Confirmer l'envoi d'un courrier qui a été créé ave

Confirmer l'envoi d'un courrier qui a été créé avec "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

Listez vos posta_massiva

Listez vos 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
}

Envoyez un posta_massiva. Vous devez fournir des i

Envoyez un posta_massiva. Vous devez fournir des informations sur l'expéditeur et le(s) destinataire(s) dans le corps du message. En outre, le paramètre "autoconfirmation" peut être mis à faux pour le sauvegarder en vue d'une confirmation ultérieure avec une demande PATCH, pendant que vous effectuez une logique personnalisée avec la réponse.

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)

Le document peut être une chaîne de caractères ou un tableau de chaînes de caractères en texte brut.
Les chaînes peuvent être soit :

  • Texte brut
  • Formaté en HTML, avec style, balises d'en-tête, etc.
  • Une URL pointant vers une page web, un PDF ou un fichier image (les urls doivent commencer par http). Le contenu est déduit de l'en-tête "Content-Type"
  • Un fichier PDF encodé en base64. Les chaînes encodées sont déduites de l'en-tête de contenu base64 data:application/pdf;base64, : en fait, pour marquer une chaîne comme un contenu encodé base64, vous devez ajouter la chaîne susmentionnée à la sortie.
    La requête renvoie une erreur si le processus de décodage échoue sur le serveur
    • .

Le service analyse le champ "documento" (document), fusionne toutes les chaînes/documents/images dans différentes pages, les compresse légèrement (si possible) et génère un seul fichier PDF.

La taille maximale d'un document PDF, après notre compression, est de 5 MB pour tous les produits sauf Posta 4 PRO, Posta Massiva et Raccomandata Smart (ces 3 produits acceptent jusqu'à 15 MB maximum).

Le nombre maximum de pages est actuellement de 50, ou 100 si l'on utilise l'option 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"
}

Lister votre single posta_massiva

Lister votre single posta_massiva

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
state
string
Example: state=NEW

Si l'option a été définie, elle renvoie un schéma spécifique dont l'état est égal à celui demandé.

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
}

Confirmer l'envoi d'un courrier qui a été créé ave

Confirmer l'envoi d'un courrier qui a été créé avec "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