La solution la plus simple et la plus sûre pour l'envoi de vos REM massives
Gérer et automatiser l'envoi de grandes quantités de messages électroniques certifiés via l'API
Toutes les connaissances dont vous avez besoin
Vous trouverez ici quelques conseils à prendre en compte pour aborder cette API. Si vous préférez, nous fournissons des exemples de code, la documentation OAS3, la possibilité d'essayer l'API en direct via Swagger UI ou d'importer l'intégralité de la collection dans Postman. Nous proposons également un environnement Sandbox où vous pouvez expérimenter toutes sortes de requêtes de manière totalement gratuite.
Obtenir le Token dans la section appropriée avant de commencer.
- Oas file url https://console.openapi.com/oas/fr/pecmassiva.openapi.json
- Fork or import with Postman
- Production domain ws.pecmassiva.com
- Sandbox domain test.ws.pecmassiva.com
- Production Scopes 6
-
Sandbox Scopes 6
- GET test.ws.pecmassiva.com/send
- POST test.ws.pecmassiva.com/send
- GET test.ws.pecmassiva.com/inbox
- DELETE test.ws.pecmassiva.com/inbox
- GET test.ws.pecmassiva.com/quota
- DELETE test.ws.pecmassiva.com/send
PEC Massiva 1.0 (1.0.0)
Ce service propose des appels au repos pour envoyer des pecs massifs et vérifier le statut des e-mails de livraison et de confirmation de réception.
Liste de tous les e-mails se rapportant à un envoi spécifique
Renvoie le statut des e-mails de réception et de confirmation de livraison en ce qui concerne l'envoi avec le code renvoyé au moment de l'envoi du PEC
Authorizations:
path Parameters
code required | string Example: 2020082610003492 Code renvoyé lors de l'envoi du PEC |
header Parameters
x-username required | string Nom d'utilisateur de l'e-mail à vérifier |
x-password required | string Mot de passe de l'e-mail à vérifier |
Responses
Response Schema: application/json
Array of objects (ResponseStatus) | |
success | boolean |
message | string |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.pecmassiva.com/send/%7Bcode%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "x-username: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "x-password: SOME_STRING_VALUE"); 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
- 200
- 401
- 404
- "data": [
- {
- "data": "Wed, 26 Aug 2020 10:00:35 +0200",
- "object": "ACCETTAZIONE: Invio di prova pec massiva 2020082610003492",
- "message": ""
- {
- "data": "Wed, 26 Aug 2020 10:00:35 +0200",
- "object": "POSTA CERTIFICATA: Invio di prova pec massiva 2020082610003492",
- "message": "Salve, questa email � una prova di invio, che prevede un corpo in html"
- {
- "data": "Wed, 26 Aug 2020 10:00:36 +0200",
- "object": "CONSEGNA: Invio di prova pec massiva 2020082610003492",
- "message": "Salve, questa email � una prova di invio, che prevede un corpo in html"
- "success": true,
- "message": ""
Suppression de tous les e-mails se rapportant à un envoi spécifique
Supprimez de votre INBOX la réception et la confirmation de livraison d'un e-mail envoyé.
Authorizations:
path Parameters
code required | string Example: 2020082610003492 Code renvoyé lors de l'envoi du PEC |
header Parameters
x-username required | string Nom d'utilisateur de l'e-mail à vérifier |
x-password required | string Mot de passe de l'e-mail à vérifier |
Responses
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.pecmassiva.com/send/%7Bcode%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "x-username: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "x-password: SOME_STRING_VALUE"); 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
- 200
- 401
- 404
- "success": true,
- "message": "Operation succefull"
Envoi d'un PEC au destinataire envoyé
Envoyez un PEC au destinataire envoyé et renvoyez le code d'identification de l'envoi, qui peut être utilisé pour renvoyer les informations sur les e-mails d'accusé de réception et de livraison.
Les destinataires peuvent être un ou plusieurs : vous pouvez indiquer soit une adresse unique, soit un tableau de destinataires
Notez que ce point final peut traiter jusqu'à 1 requête/seconde.
Authorizations:
Request Body schema: application/json
sender | string |
string or Array of strings Envoyer un e-mail à un ou plusieurs destinataires. Ce champ accepte soit une chaîne de caractères, soit un tableau de chaînes de caractères. | |
subject | string |
body | string |
object (Attachment) | |
username | string |
password | string |
Responses
Response Schema: application/json
success | boolean |
message | string |
message_id | string |
sent | integer Le nombre d'e-mails PEC envoyés |
Request samples
- Payload
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
- "subject": "Invio di prova pec massiva",
- "body": "Salve, questa rappresenta una prova di invio, che prevede un <b>corpo in html</b>",
- "attachments": [
- {
- "name": "allegato1.png",
- "file": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNMEgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTQgKFdpbmRvd3MpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOjQ1RTFGMzU5NzA3RTExRTdBRjRFRTc2MUNCMDFEREIzIiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOjQ1RTFGMzVBNzA3RTExRTdBRjRFRTc2MUNCMDFEREIzIj4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOml......"
- "username": "your_pec_username",
- "password": "your_pec_password"
Response samples
- 201
- 400
- 401
- 500
- "success": true,
- "sent": 1,
- "message": "",
- "message_id": "2020082610003492"
Renvoie un seul message dans l'INBOX
Renvoie un seul message. Veuillez noter que le corps est une chaîne de caractères codée en x-www-form-urlencoded
Authorizations:
path Parameters
id required | number Example: 3 L'ID du message que vous avez reçu de /inbox |
header Parameters
x-username required | string Nom d'utilisateur de l'e-mail à vérifier |
x-password required | string Mot de passe de l'e-mail à vérifier |
Responses
Response Schema: application/json
object (InboxSingle) | |
success | boolean |
message | string |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.pecmassiva.com/inbox/%7Bid%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "x-username: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "x-password: SOME_STRING_VALUE"); 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
- 200
- 401
- 404
- "data": {
- "date": "Mon, 21 Sep 2020 15:26:37 +0200",
- "object": "ACCETTAZIONE: Invio di prova pec massiva 202009211526363",
- "body": "This is an example body."
- "success": true,
- "message": ""
Supprimer un e-mail
Supprimez de votre INBOX la réception et la confirmation de livraison d'un e-mail envoyé.
Authorizations:
path Parameters
id required | number Example: 3 L'ID du message que vous avez reçu de /inbox |
header Parameters
x-username required | string Nom d'utilisateur de l'e-mail à vérifier |
x-password required | string Mot de passe de l'e-mail à vérifier |
Responses
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.pecmassiva.com/inbox/%7Bid%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "x-username: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "x-password: SOME_STRING_VALUE"); 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
- 200
- 401
- "success": true,
- "message": "Message deleted"
Obtenir une liste des e-mails dans votre boîte de réception
Renvoie le contenu de votre INBOX. Les résultats peuvent être paginés : chaque page contient jusqu'à 25 messages et possède un identifiant unique que vous pourrez utiliser ultérieurement pour obtenir ou supprimer le message individuel.
En outre, vous pouvez également effectuer une recherche avec le paramètre 'q'. Veuillez noter que la recherche peut être lente dans une boîte aux lettres très remplie.
Authorizations:
query Parameters
q | string Critères de recherche |
page | number Page actuelle |
header Parameters
x-username required | string Nom d'utilisateur de l'e-mail à vérifier |
x-password required | string Mot de passe de l'e-mail à vérifier |
Responses
Response Schema: application/json
Array of objects (InboxSearch) | |
success | boolean |
message | string |
page | number |
total | number |
n_of_pages | number |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.pecmassiva.com/inbox?q=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "x-username: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "x-password: SOME_STRING_VALUE"); 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
- 200
- 401
- "data": [
- {
- "date": "Wed, 26 Aug 2020 10:00:35 +0200",
- "object": "ACCETTAZIONE: Invio di prova pec massiva 2020082610003492",
- "id": 1
- {
- "date": "Wed, 26 Aug 2020 10:00:35 +0200",
- "object": "POSTA CERTIFICATA: Invio di prova pec massiva 2020082610003492",
- "id": 2
- {
- "date": "Wed, 26 Aug 2020 10:00:36 +0200",
- "object": "CONSEGNA: Invio di prova pec massiva 2020082610003492",
- "id": 3
- "success": true,
- "message": "",
- "total": 981,
- "page": 39,
- "n_of_pages": 39
Renvoie l'utilisation de votre INBOX
Fournit des informations sur le taux d'utilisation de votre INBOX en mégaoctets.
Authorizations:
path Parameters
mailbox required | string Example: inbox La boîte aux lettres à vérifier. Vous pouvez utiliser "INBOX" pour vérifier l'état de votre boîte aux lettres principale. |
header Parameters
x-username required | string Nom d'utilisateur de l'e-mail à vérifier |
x-password required | string Mot de passe de l'e-mail à vérifier |
Responses
Response Schema: application/json
object (QuotaResponse) | |
success | boolean |
message | string |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.pecmassiva.com/quota/inbox"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "x-username: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "x-password: SOME_STRING_VALUE"); 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
- 200
- 400
- 401
- "data": {
- "usage": 171012,
- "limit": 1048576
- "success": true,
- "message": ""