Come generare il tuo API client per le API di SEND
In questo tutorial vedremo come generare i client, e come utilizzarli, per effettuare chiamate alle API di SEND.
E' possibile generare il client per tutti i linguaggi di programmazione, con il tool openapi-generator la cui documentazione è presente al seguente link: https://openapi-generator.tech Dopo aver scaricato il tool sulla propria macchina, bisognerà lanciare il seguente comando:
openapi-generator-cli generate -i <urlFileSwagger> -g <lang> -o <dest>sostituendo:
- <urlFileSwagger>: con la url del file Swagger del quale si vuole generare il client. E' possibile utilizzare: https://raw.githubusercontent.com/pagopa/pn-delivery/pn-openapi-devportal/docs/openapi/api-external-b2b-pa-bundle.yaml
- <lang>: con il linguaggio per il quale si vuole generare il client
- <dest>: con il path nel quale si vuole generare il client\
E' anche possibile utilizzare il pn-b2b-client pubblico sviluppato da PagoPA ed utilizzare le classi Java in esso contenute per sviluppare la propria soluzione
Per importare le definizioni su Postman bisogna cliccare su "import", poi selezionare "Link" ed inserire il seguenti url:
https://raw.githubusercontent.com/pagopa/pn-delivery/v2.1.0/docs/openapi/api-external-b2b-pa-bundle.yaml
Poi modificare i seguenti parametri delle collections ottenute:
- nel tab "Variables" modificare la variables baseUrl con: https://api.uat.notifichedigitali.it (ambiente di test UAT)
- nel tab "Authorization" selezionare nella tendina "Type" il valore "API Key", poi inserire nella casella "Key" il valore x-api-key e nella casella "Value" il valore della key generata dalla propria area riservata (di seguito le istruzioni)
- aggiungere il "Authorization: Bearer <PDNDVoucher>"in ogni chiamata verso i servizi B2B (ad esclusione di quelli verso AWS) con il Voucher ottenuto da PDND Interoperabilità ed assicurarsi che sia sempre valido e non scaduto.
Per creare le API key bisognerà effettuare il log in nel portale lato PA da qui: https://uat.selfcare.pagopa.it/auth/login con le credenziali che sono state fornite durante il processo di Onboarding, andare nella sezione apikey, cliccare su “genera API key”, inserire il nome dell’API key e selezionare “continua”.
NOTA: Se si crea una API key associata ad un gruppo, diventerà obbligatorio inserire notifiche valorizzando il campo "group" con l'id del gruppo di appartenenza.
Le operazioni di creazione, rotazione ed eliminazione sulle API key sono a discrezione dell'utente, che può gestirle autonomamente.
vedi: Focus su creazione richiesta di fruizione generazione Voucher per SEND - UAT (Piattaforma Notifiche)
