Web Services – API per automatizzare la ricerca PEC

Web Services - API per automatizzare la ricerca PEC

Introduzione ai Web Services 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.
Il servizio è basato su alcuni semplici passaggi necessari per richiedere un indirizzo PEC:

  1. Invio di una richiesta contentente la partita iva o codice fiscale di cui si cerca la pec
  2. Ricezione di un codice prenotazione (token) da utilizzare successivamente per ottenere la risposta
  3. Inizio di un ciclo di richieste finchè il risultato diventa disponibile
  4. 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 valorizzandoli opportunamente e inviarli all’url del servizio.
L’url del servizio da utilizzare è: http://trovapec.consulinformatica.it/index.php

Abbiamo predisposto 3 semplici form per simulare interattivamente il processo:
http://trovapec.consulinformatica.it/index_post.html: per inviare la prima richiesta
http://trovapec.consulinformatica.it/index_get.html: per ottenere le risposte, ovvero l’esito della ricerca.

Eventuale richiesta di cancellazione:

http://trovapec.consulinformatica.it/index_delete.html: per eliminare una richiesta precedente.

E’ possibile scaricare i form, personalizzarli e integrarli con i propri sistemi.

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à presenteUna richiesta è già presenteE’ possibile cancellare la precedente richiesta
   

Richiesta Esito PecMetodo: GET 
 PARAMETRIDescrizione 
 keyLa user-key associata alla vostra utenza obbligatorio
 tokenIl valore ottenuto dalla richiesta precedente obbligatorio
 RISPOSTE  
OK|pec@pec.it|stato Richiesta processata correttamenteEsempi: Ok||pec non trovata
OK|pec@pec.it|pec trovata
WAIT|tokenE’ necessario attendere e richiedere
nuovamente l’esito
La richiesta viene evasa in 2-3 minuti
ERROR|descrizione errore  

Cancellazione Richiesta PecMetodo: POST 
 PARAMETRIDescrizione 
 keyLa user-key associata alla vostra utenza obbligatorio
 cf-deleteIl codice fiscale della richiesta da eliminare obbligatorio
 RISPOSTE  
OK|richiesta cancellata correttamenteRichiesta cancellata correttamente 

 

Richiesta Saldo AccountMetodo: POST 
 PARAMETRIDescrizione 
 keyLa user-key associata alla vostra utenza obbligatorio
saldo

è sufficiente la presenza del campo, non 

deve essere valorizzato

 
 RISPOSTE  
importo del saldo