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

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.

Utilitaires & Informations

Méthodes de support pour la tarification, les pays, les adresses, le suivi et les codes postaux.

Obtenir Tous les Tarifs
GET /pricing/
Récupère la liste des tarifs pour tous les services disponibles.

Obtenir le Tarif d'un Service
GET /pricing/{service}
Obtient les détails de la tarification pour un service spécifique.

Obtenir les Pays pour un Service
GET /nazioni/{service}
Récupère la liste des pays pris en charge pour un service spécifique.

Obtenir la Liste Complète des Pays
GET /nazioni/
Récupère la liste complète des pays pris en charge.

Lister les Adresses (Normalisation)
GET /indirizzi/
Permet la validation et la normalisation d'une adresse italienne.

Lister les DUG
GET /dug/
Retourne la liste des DUG (Denominazione Urbanistica Generica) valides.

Suivre un Envoi
GET /tracking/{id}
Récupère le statut de suivi pour un ID d'envoi spécifique.

Obtenir des Infos sur le Code Postal
GET /comuni/{code}
Obtient des informations sur les municipalités (comuni) associées à un code postal (CAP).

Gestion des Couvertures

Méthodes pour gérer les modèles de couverture personnalisés.

Lister les Couvertures
GET /covers/
Récupère toutes les configurations de couverture enregistrées pour votre compte.

Créer une Couverture
POST /covers/
Crée et enregistre une nouvelle configuration de couverture personnalisée.

Obtenir les Détails d'une Couverture
GET /covers/{id}
Récupère les détails d'une configuration de couverture spécifique par son ID.

Obtenir un Aperçu de la Couverture
GET /covers/{id}/preview
Obtient une image ou un PDF d'aperçu d'une configuration de couverture spécifique.

Télégrammes (Telegrammi)

Méthodes pour la gestion des télégrammes.

Créer une Demande de Télégramme
POST /telegrammi/
Crée une nouvelle demande de télégramme.

Lister les Télégrammes
GET /telegrammi/
Liste vos demandes de télégramme créées précédemment.

Obtenir les Détails d'un Télégramme
GET /telegrammi/{id}
Récupère les détails et le statut d'un télégramme spécifique.

Confirmer l'Envoi d'un Télégramme
PATCH /telegrammi/{id}
Confirme l'envoi d'une demande de télégramme créée précédemment.

Actes Judiciaires (Atti Giudiziari)

Méthodes pour la gestion des Actes Judiciaires. Inclut le suivi.

Créer une Demande d'Acte Judiciaire
POST /atti_giudiziari/
Crée une nouvelle demande d'envoi d'acte judiciaire.

Lister les Actes Judiciaires
GET /atti_giudiziari/
Liste vos demandes d'actes judiciaires créées précédemment.

Obtenir les Détails d'un Acte Judiciaire
GET /atti_giudiziari/{id}
Récupère les détails et le statut d'un acte judiciaire spécifique.

Confirmer l'Envoi d'un Acte Judiciaire
PATCH /atti_giudiziari/{id}
Confirme l'envoi d'une demande d'acte judiciaire créée précédemment.

Télécharger le Récépissé d'Acceptation
GET /atti_giudiziari/{id}/accettazione
Télécharge le récépissé d'acceptation pour un acte judiciaire envoyé.

Télécharger l'Avis de Réception Numérique (AR Digitale)
GET /atti_giudiziari/{id}/destinatari/{IdDestinatario}/ardigitale
Télécharge l'avis de réception numérique pour un destinataire spécifique d'un acte judiciaire.

Télécharger le Document Archivé
GET /atti_giudiziari/{id}/destinatari/{IdDestinatario}/archiviazione
Télécharge le document archivé pour un destinataire spécifique d'un acte judiciaire.

Courrier Recommandé (Raccomandate)

Méthodes pour la gestion du courrier recommandé. Inclut le suivi.

Créer une Demande de Courrier Recommandé
POST /raccomandate/
Crée une nouvelle demande d'envoi de courrier recommandé.

Lister les Courriers Recommandés
GET /raccomandate/
Liste vos demandes de courrier recommandé créées précédemment.

Obtenir les Détails d'un Courrier Recommandé
GET /raccomandate/{id}
Récupère les détails et le statut d'un courrier recommandé spécifique.

Confirmer l'Envoi d'un Courrier Recommandé
PATCH /raccomandate/{id}
Confirme l'envoi d'une demande de courrier recommandé créée précédemment.

Télécharger le Récépissé d'Acceptation
GET /raccomandate/{id}/accettazione
Télécharge le récépissé d'acceptation pour un courrier recommandé envoyé.

Télécharger le Document Archivé
GET /raccomandate/{id}/destinatari/{IdDestinatario}/archiviazione
Télécharge le document archivé pour un destinataire spécifique d'un courrier recommandé.

Courrier Prioritaire (Posta Prioritaria)

Méthodes pour la gestion du courrier prioritaire. Inclut un code de suivi de statut.

Créer une Demande de Courrier Prioritaire
POST /prioritarie/
Crée une nouvelle demande d'envoi de courrier prioritaire.

Lister les Courriers Prioritaires
GET /prioritarie/
Liste vos demandes de courrier prioritaire créées précédemment.

Obtenir les Détails d'un Courrier Prioritaire
GET /prioritarie/{id}
Récupère les détails d'un courrier prioritaire spécifique.

Confirmer l'Envoi d'un Courrier Prioritaire
PATCH /prioritarie/{id}
Confirme l'envoi d'une demande de courrier prioritaire créée précédemment.

Télécharger le Document Archivé
GET /prioritarie/{id}/destinatari/{IdDestinatario}/archiviazione
Télécharge le document archivé pour un destinataire spécifique d'un courrier prioritaire.

Courrier Ordinaire (Posta Ordinaria)

Méthodes pour la gestion du courrier ordinaire.

Créer une Demande de Courrier Ordinaire
POST /ordinarie/
Crée une nouvelle demande d'envoi de courrier ordinaire.

Lister les Courriers Ordinaires
GET /ordinarie/
Liste vos demandes de courrier ordinaire créées précédemment.

Obtenir les Détails d'un Courrier Ordinaire
GET /ordinarie/{id}
Récupère les détails d'un courrier ordinaire spécifique.

Confirmer l'Envoi d'un Courrier Ordinaire
PATCH /ordinarie/{id}
Confirme l'envoi d'une demande de courrier ordinaire créée précédemment.

Télécharger le Document Archivé
GET /ordinarie/{id}/destinatari/{IdDestinatario}/archiviazione
Télécharge le document archivé pour un destinataire spécifique d'un courrier ordinaire.

Courrier Recommandé Smart (Raccomandata Smart)

Méthodes pour la gestion du Courrier Recommandé Smart.

Créer une Demande de Courrier Recommandé Smart
POST /raccomandate_smart/
Crée une nouvelle demande d'envoi de Courrier Recommandé Smart.

Lister les Courriers Recommandés Smart
GET /raccomandate_smart/
Liste vos demandes de Courrier Recommandé Smart créées précédemment.

Obtenir les Détails d'un Courrier Recommandé Smart
GET /raccomandate_smart/{id}
Récupère les détails d'un Courrier Recommandé Smart spécifique.

Confirmer l'Envoi d'un Courrier Recommandé Smart
PATCH /raccomandate_smart/{id}
Confirme l'envoi d'une demande de Courrier Recommandé Smart créée précédemment.

Envoi en Nombre (Posta Massiva)

Méthodes pour la gestion des envois en nombre.

Créer une Demande d'Envoi en Nombre
POST /posta_massiva/
Crée une nouvelle demande d'envoi en nombre.

Lister les Envois en Nombre
GET /posta_massiva/
Liste vos demandes d'envoi en nombre créées précédemment.

Obtenir les Détails d'un Envoi en Nombre
GET /posta_massiva/{id}
Récupère les détails d'une demande d'envoi en nombre spécifique.

Confirmer l'Envoi en Nombre
PATCH /posta_massiva/{id}
Confirme l'envoi d'une demande d'envoi en nombre créée précédemment.

Oas file url https://console.openapi.com/oas/fr/ufficiopostale.openapi.json
Fork or import with Postman
Production domain ws.ufficiopostale.com
Sandbox domain test.ws.ufficiopostale.com
Production Scopes 33
Sandbox Scopes 33
- GET test.ws.ufficiopostale.com/indirizzi
- GET test.ws.ufficiopostale.com/tracking
- GET test.ws.ufficiopostale.com/comuni
- GET test.ws.ufficiopostale.com/dug
- GET test.ws.ufficiopostale.com/raccomandate
- POST test.ws.ufficiopostale.com/raccomandate
- PATCH test.ws.ufficiopostale.com/raccomandate
- GET test.ws.ufficiopostale.com/pricing
- PATCH test.ws.ufficiopostale.com/telegrammi
- POST test.ws.ufficiopostale.com/telegrammi
- GET test.ws.ufficiopostale.com/telegrammi
- POST test.ws.ufficiopostale.com/ordinarie
- GET test.ws.ufficiopostale.com/ordinarie
- PATCH test.ws.ufficiopostale.com/ordinarie
- POST test.ws.ufficiopostale.com/prioritarie
- GET test.ws.ufficiopostale.com/prioritarie
- PATCH test.ws.ufficiopostale.com/prioritarie
- GET test.ws.ufficiopostale.com/posta_4_pro
- POST test.ws.ufficiopostale.com/posta_4_pro
- PATCH test.ws.ufficiopostale.com/posta_4_pro
- GET test.ws.ufficiopostale.com/posta_massiva
- POST test.ws.ufficiopostale.com/posta_massiva
- PATCH test.ws.ufficiopostale.com/posta_massiva
- GET test.ws.ufficiopostale.com/raccomandate_smart
- POST test.ws.ufficiopostale.com/raccomandate_smart
- PATCH test.ws.ufficiopostale.com/raccomandate_smart
- GET test.ws.ufficiopostale.com/nazioni
- POST test.ws.ufficiopostale.com/covers
- GET test.ws.ufficiopostale.com/covers
- DELETE test.ws.ufficiopostale.com/covers
- POST test.ws.ufficiopostale.com/atti_giudiziari
- PATCH test.ws.ufficiopostale.com/atti_giudiziari
- GET test.ws.ufficiopostale.com/atti_giudiziari

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

Créer un nouveau courrier avec une requête POST
Vérifier les prix et les confirmer avec un PATCH, ou utiliser autoconfirm : true
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

{

"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

}

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": [
- "string"
],
"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": [
- {
  - "codice_dug": "BGO",
  - "dug": "Borgo"
  }
],
"message": "1 Risultato",
"success": true,
"error": null

}

Suivre votre produit

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

}

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

{

"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

Obtenir des informations sur un télégramme

Authorizations:

bearerAuth

path Parameters

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": {
- "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

}

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

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

}

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": [
- {
  - "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

}

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": {
- "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

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": [
- {
  - "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

}

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": {
- "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"

}

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

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": {
- "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

}

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

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

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": [
- {
  - "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

}

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": {
- "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"

}

Obtenir des informations sur un courrier prioritaire unique

Authorizations:

bearerAuth

path Parameters

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": {
- "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

}

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

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

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": [
- {
  - "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

}

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": {
- "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"

}

Obtenir des informations sur un seul courrier

Authorizations:

bearerAuth

path Parameters

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": {
- "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

}

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

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

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": [
- {
  - "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

}

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": [
- {
  - "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"

}

Listez votre single raccomandata smart

Authorizations:

bearerAuth

path Parameters

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": [
- {
  - "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

}

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

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

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": [
- {
  - "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

}

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": {
- "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"

}

Lister votre single posta_massiva

Authorizations:

bearerAuth

path Parameters

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": [
- {
  - "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

}

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

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