Introduzione
In questa sezione vengono presentate tutte le API messe a disposizione per poter interfacciarsi con XPay. Ogni pagina dedicata ad un API viene così suddivisa:
- Metodo di chiamata e URI: utilizzata come titolo e identificativo dell'API.
- URL: indirizzo completo di test e produzione verso cui eseguire le chiamate GET o POST.
- Descrizione: breve descrizione dell'API, contenente il link alla pagina dedicata con maggiori informazioni.
- Tabella dei parametri: tutte le informazioni riguardo i parametri di avvio ed esito.
Prima di procedere con l'implementazione delle API, è sempre consigliata la visualizzazione delle Specifiche di utilizzo del servizio, in cui sono presentate le informazioni per la corretta comunicazione con XPay.
Per poter utilizzare le API, è necessario recuperare il parametro "X-Api-Key", dato chiave e identificativo del terminale dell'esercente, che deve essere inviato nell'header di ciascuna chiamata API. In fase di test è possibile trovare questo dato nella sezione Api-Key, mentre in produzione questa chiave viene generata da back office XPay. Per generare le nuove credenziali per l'ambiente di produzione seguire questi passaggi:
- Accedere a Nexi Business.
- Effettuare il login al Back Office di XPay Web.
- Nella sezione "Admin" cliccare su "APIKey".
- Cliccare su "Aggiungere nuova APIKey".
- Una volta selezionato il terminale, cliccare su "Aggiungi" per generare l'API Key di produzione.
Le API vengono suddivise in aree funzionali:
- Pagamenti: API dedicate alle modalità di integrazione.
- Back office: API dedicate alle funzionalità di back office.
- Incasso senza pensieri: API dedicate ai servizi per Hotel e Ristoranti.