Generazione API Key
La funzionalità generazione delle API Key è una delle operazione necessarie per l’attivazione del prodotto pagoPA e che, in particolare, consente la connessione al Nodo dei Pagamenti PagoPA.
Last updated
La funzionalità generazione delle API Key è una delle operazione necessarie per l’attivazione del prodotto pagoPA e che, in particolare, consente la connessione al Nodo dei Pagamenti PagoPA.
Last updated
All’interno della Panoramica - Area riservata, per il prodotto pagoPA cliccando sul pulsante "Gestisci" viene esposto il messaggio che permette di selezionare l’ambiente target a cui si intende accedere (Ambiente di Collaudo e Ambiente di Produzione).
E' possibile accedere al portale del prodotto pagoPA anche dall’apposito menù a tendina situato al lato sinistro dell’intestazione. Anche da qui sarà possibile selezionare l’ambiente target.
Per avviare la generazione delle chiavi è necessario scegliere l'ambiente target, ad esempio "Collaudo", cliccando sull'omonimo tasto. Solo dopo aver completato la generazione nel primo ambiente selezionato, sarà possibile effettuarla anche nel secondo (ovvero "Produzione").
Dalla Panoramica - Area riservata, dopo aver cliccato sul pulsante "Gestisci" del prodotto e aver selezionato l'ambiente target, ad esempio "Collaudo", l'utente accede alla Pagina Vista API Key.
Nella suddetta Pagina è possibile procedere alla generazione delle chiavi cliccando sul tasto “+ Genera API Key” o su link in blu “Genera API Key”.
Effettuando il click, si accede alla Pagina di Selezione tipo di prodotto
Nella Pagina di Selezione tipo di prodotto, tramite Il menu a tendina “Tipo di prodotto”, è possibile visualizzare l’elenco delle tipologie di prodotto per cui è necessario generare le chiavi:
L'elenco di seguito è indicativo in quanto le tipologie di prodotto sono in continua evoluzione e potranno cambiare nel corso del tempo.
Connessione con nodo
GPD - Posizioni Debitorie
GPD - Recupero Ricevute
GPD - Gestione Flussi di Rendicontazione
BIZ - Recupero Ricevute Ente Creditore
FdR - Flussi di Rendicontazione (EC)
Backoffice External (EC)
La prossima sezione descrive il processo di generazione di una coppia di API Key per una tipologia di prodotto, la principale, ovvero la connessione con nodo.
Le altre tipologie di prodotto, per semplicità non descritte hanno rispettivamente i seguenti compiti:
GPD - Posizioni Debitorie -> prodotto da utilizzare nell'ambito dell'integrazione asincronaper la gestione delle posizioni debitorie
GPD - Recupero ricevute -> prodotto da utilizzare nell'ambito dell'integrazione asincronaper il recupero delle ricevute di pagamento
GPD - Gestione flussi di rendicontazione -> prodotto da utilizzare nell'ambito dell'integrazione asincronaper la gestione dei flussi di rendicontazione da parte dei PSP
BIZ - Recupero ricevute Ente Creditore -> prodotto da utilizzare nell'ambito dell'integrazione asincronaper il recupero delle ricevute di pagamento
FdR - Flussi di Rendicontazione (EC) -> prodotto da utilizzare per recuperare i flussi di rendicontazione da parte dei PSP
Backoffice External (EC) -> prodotto da utilizzare per le API esterne descritte nella sezione "External API"
Connessione con nodo
Questa API Key permette di connettersi al Nodo Pagamenti di PagoPA: azione propedeutica per tutte le ulteriori operazioni.
Per procedere, dal menù è necessario selezionare il prodotto “Connessione con nodo”, l’unico abilitato dato che è obbligatorio generare prima la coppia di chiavi di questa tipologia per poi procedere con le altre chiavi.
Solo una volta selezionata la voce, sarà possibile proseguire cliccando sul pulsante “Genera API Key”; altrimenti sul tasto “Annulla” per tornare alla Pagina Vista API Key.
Una volta aver cliccato sul pulsante “Genera API Key”, se la coppia di chiavi (primaria e secondaria) è stata generata correttamente allora è possibile visualizzarle e gestirle all’interno della Pagina Vista API Key.
Per ogni campo contenente il codice API Key è possibile effettuare le seguenti azioni:
cliccare su icona a forma di occhio che consente la visualizzazione del Codice alfanumerico
cliccare sul tasto "Usa questa chiave" che permette di copiare ed incollare il codice alfanumerico;
cliccare sul tasto “Rigenera”, da cui verrà mostrato il pop up informativo che consente di generare un nuovo codice. Se si intende procedere alla generazione del nuovo codice è necessario cliccare sul pulsante “Rigenera”, altrimenti sul pulsante “Annulla” al fine di chiudere il pop up.
Completata la fase di generazione delle chiavi, nella Pagina Vista API Key è possibile visualizzare i prodotti con la coppia di chiavi primaria e secondaria ad essi associate e i relativi comandi di gestione del codice.
Per procedere è necessario ritornare nella Panoramica - Area Riservata, selezionandola dal menu a tendina situato al lato sinistro dell'intestazione.
Dalla Panoramica - Area riservata, cliccando sulla freccia all'interno della card relativa al prodotto è possibile selezionare il secondo ambiente per cui si intende effettuare la generazione "Produzione".
L'utente potrà procedere alla generazione delle API Key di produzione seguendo le stesse azioni illustrate nella sezione API Key: Ambiente di Collaudo.
