Introduzione ai Web Services – API Rest per la ricerca PEC
Abbiamo implementato alcuni Web Services, in modalità RESTful, che permettono di automatizzare il processo di richiesta delle PEC, integrando i vostri software con i nostri servizi.
Se non vuoi o non sai come integrarli nelle tue applicazioni, è disponibile un nuovo programma facilmente installabile e configurabile che interagisce con il tuo sistema. Se vuoi maggiori informazioni contattaci
Il servizio è basato su alcuni semplici passaggi necessari per richiedere un indirizzo PEC:
- Invio di una richiesta contentente la partita iva o codice fiscale di cui si cerca la pec
- Ricezione di un codice prenotazione (token) da utilizzare successivamente per ottenere la risposta
- Inizio di un ciclo di richieste finchè il risultato diventa disponibile
- Ottenimento del risultato.
Il web service non prevede la ricerca per ragione sociale.
L’attivazione del servizio è subordinato alla definizione della modalità di fatturazione, anticipata o posticipata e alla fornitura di un codice identificativo cliente, che dovrà essere utilizzato per ciascuna richiesta.
Specifiche Tecniche
I metodi da utilizzare sono principalmente 2, da usare in sequenza:
Invio Richiesta Pec: tramite il metodo POST
Richiesta Esito della Ricerca Pec: tramite il metodo GET
Per utilizzarli è sufficiente creare un form html, inserire i parametri specifici come campi “text”, valorizzandoli opportunamente e inviarli all’url del servizio.
L’url del servizio da utilizzare è: https://trovaindirizzipec.it/PecApi/index_ws.php
Abbiamo predisposto alcuni semplici form per simulare interattivamente il processo:
https://www.trovaindirizzipec.it/PecApi/index_post.html: per inviare la prima richiesta
https://www.trovaindirizzipec.it/PecApi/index_get.html: per ottenere le risposte, ovvero l’esito della ricerca.
Eventuale richiesta di cancellazione:
https://trovaindirizzipec.it/PecApi/index_delete.html: per eliminare una richiesta precedente.
Per verificare il saldo:
https://trovaindirizzipec.it/PecApi/check_saldo.html
Di seguito riportiamo gli schemi con tutte le caratteristiche dei metodi:
| Invio Richiesta Pec | Metodo: POST | |
| PARAMETRI | Descrizione | |
| key | La user-key associata alla vostra utenza | obbligatorio |
| cf | La partita iva o codice fiscale da cercare | obbligatorio |
| RISPOSTE | ||
| OK|CodiceToken | La richiesta è andata a buon fine viene restituito il token per il passaggio successivo | |
| Error|Richiesta già presente | Una richiesta è già presente | E’ possibile cancellare la precedente richiesta |
| Richiesta Esito Pec | Metodo: GET | |
| PARAMETRI | Descrizione | |
| key | La user-key associata alla vostra utenza | obbligatorio |
| token | Il valore ottenuto dalla richiesta precedente | obbligatorio |
| RISPOSTE | ||
| OK|pec@pec.it|stato | Richiesta processata correttamente | Esempi: Ok||pec non trovata OK|pec@pec.it|pec trovata |
| WAIT|token | E’ necessario attendere e richiedere nuovamente l’esito | La richiesta viene evasa in 2-3 minuti |
| ERROR|descrizione errore |
| Cancellazione Richiesta Pec | Metodo: POST | |
| PARAMETRI | Descrizione | |
| key | La user-key associata alla vostra utenza | obbligatorio |
| cf-delete | Il codice fiscale della richiesta da eliminare | obbligatorio |
| RISPOSTE | ||
| OK|richiesta cancellata correttamente | Richiesta cancellata correttamente |
| Richiesta Saldo Account | Metodo: POST | |
| PARAMETRI | Descrizione | |
| key | La user-key associata alla vostra utenza | obbligatorio |
| saldo | è sufficiente la presenza del campo, non deve essere valorizzato | |
| RISPOSTE | ||
| importo del saldo |