Torna al Prodotto

PmPay - API PagoPA

Nozioni base per poter operare efficacemente con le api rest di PMPay pagoPA. Verrà spiegato come ottenere un token di sessione, come comporre le richieste ed i possibili risultati che si possono ricevere. Le API di PMPay pagoPA possono essere invocate sull'ambiente di produzione https://secure.pmpay.it/pagoparest ambiente reale da cui è possibile agire su entità concrete e attivare flussi di esercizio.

  • Chiamata POST all’url /autenticazione
    L’accesso tramite API a tutte le entità dell’ecosistema PMPay pagoPA è protetto, per poter effettuare una chiamata API sarà dunque necessario presentarsi con un access token. Per ottenere questo token bisognerà quindi effettuare una chiamata di autenticazione usando la propria utenza tecnica composta da nome e password.
    Scadenza token: Una volta raggiunta la scadenza del token le invocazioni delle API inizieranno a rispondere con un messaggio di errore 401 e sarà quindi necessario ripetere la procedura descritta nel paragrafo precedente per ottenere un nuovo token valido.

  • Inserimento batch
    Ogni metodo d’inserimento (o aggiornamento) entità si aspetta in input le informazioni relative ad un solo oggetto. Per supportare l’upload multiplo senza iterare numerose richieste sullo stesso endpoint è disponibile una rotta ad-hoc per gestire questa necessità. La modalità batch prevede l’inserimento di un’operazione massiva che verrà poi eseguita in un secondo momento. Il risultato della chiamata quindi non sarà garanzia del successo delle operazioni riguardanti i singoli record forniti ma sarà invece la conferma che la richiesta è stata presa in carico e che verrà completata di lì a poco in base al carico sull’infrastruttura.

    Nel body della richiesta tra le varie informazioni tecniche deve essere fornito anche un file in formato JSON (può anche essere compresso in un archivio zip) contenente tutte le informazioni richieste dall’endpoint per l’inserimento singolo.

    Ad esempio in caso si volesse effettuare l’inserimento di 1000 pagamenti sarà necessario quindi fornire un file contenente un array di 1000 oggetti json validabili rispetto allo schema atteso dalla modalità ad inserimento singolo (/ente/{codiceEnte}/pagamento).