Nel linguaggio comune, il termine Swagger indica la pagina di documentazione tecnica attraverso cui consultare le API. Più precisamente, OpenAPI è il formato che descrive le API, mentre Swagger UI è l'interfaccia che rende quella descrizione navigabile. Swagger UI è predisposto anche per effettuare chiamate di prova agli endpoint, ma quest'ultima opzione non è attiva su PEOPLELINK.
Swagger permette quindi di capire come costruire una richiesta, quali informazioni inviare e quale risposta aspettarsi.
Orientarsi nell'interfaccia
L'interfaccia dello Swagger PEOPLELINK mette a disposizione due definizioni, selezionabili dal menu Select a definition posto in testata:
· quella del servizio token ACS, dedicata all'autenticazione e all'ottenimento del token di accesso temporaneo
· quella delle API applicative, che documenta le funzionalità disponibili per l'integrazione, con i relativi parametri, formati delle richieste e risposte previste.
Il primo passo è quindi scegliere la definizione corrispondente all'attività da svolgere: ottenere il token oppure consultare e utilizzare le API vere e proprie.
Nella sezione Servers sono indicati gli indirizzi dei due ambienti disponibili: produzione, destinato all'utilizzo operativo, e sviluppo, da utilizzare per le attività di sviluppo e test se si dispone di un ambiente di sviluppo dedicato.
È importante distinguere queste due selezioni: la definizione determina quale documentazione viene visualizzata, mentre il server mostra la destinazione che le chiamate dovranno avere. Prima di procedere, occorre verificare di aver scelto l'ambiente corretto e di utilizzare indirizzi e credenziali coerenti per il servizio ACS e per le API applicative, tenendo presente che i rispettivi URL sono distinti.
Scoprire come sono organizzate le API
Gli endpoint delle API sono categorizzati sulla base del modulo PEOPLELINK oppure, nel caso siano generali, ovvero validi per tutti i moduli, indicate come ALL. Sono anche categorizzati in base al fatto che siano in lettura o in scrittura (evidenziazione in rosso). Questa organizzazione permette di individuare l'area interessata senza dover esaminare subito tutti i percorsi disponibili. In sequenza, in ogni categoria, sono elencati tutti gli endpoint a quest'ultima associati (evidenziati in blu).
Nello Swagger PEOPLELINK, i metodi HTTP, indicati alla sinistra di ogni endpoint, non indicano che un determinato endpoint sia in scrittura (POST) o in lettura (GET). Non devono, quindi, essere interpretati secondo una corrispondenza RESTful/CRUD.
La regola pratica è: il metodo indica come inviare la richiesta; la documentazione indica che cosa farà il servizio.
Ogni riga di ogni endpoint ha una struttura così composta:
1. metodo HTTP (GET o POST)
2. path dell'endpoint, da concatenare con l'URL del server
3. argomento e dati trattati dall'endpoint
4. icona per copiare l'endpoint (a comparsa quando il mouse viene posizionato sopra uno specifico endpoint)
5. icona per aprire tutti i dettagli dell'endpoint
Inoltre, dopo ogni nuovo rilascio in produzione, verrà aggiunto un badge grafico per indicare gli endpoint nuovi (NEW) o quelli che hanno subito una modifica (UPDATED). Sono previsti anche due badge speciali il cui scopo è indicare se l'endpoint è in beta (BETA) o in anteprima (PREVIEW).
Comprendere una scheda di dettaglio di un endpoint
Quando apri il dettaglio di un endpoint (clic sulla rispettiva riga), vengono mostrate tutte le informazioni necessarie al suo utilizzo, come spiegazione estesa, URL di destinazione, dati della request, formati, dati della response, snippet di codice, ecc.
Parametri e corpo della richiesta
I Parameters, presenti sia negli endpoint in GET che in POST, possono essere collocati nel path dell'URL, nella query string o negli header. La posizione è significativa: un valore documentato come parametro di header non va spostato arbitrariamente nel corpo della richiesta o in query string. Per ciascun parametro sono indicati il nome, il tipo, l'eventuale formato, l'indicazione di obbligatorietà, la posizione, una descrizione funzionale, eventuali valori di esempio, di default o consigliati.
Tutti gli endpoint PEOPLELINK richiedono sempre 4 parametri:
· X-PL-ApiToken: APIKey per gli endpoint in lettura o in scrittura, generato su PEOPLELINK nella funzionalità Chiavi di accesso per le API
· User-Agent: nome identificativo della procedura che sta eseguendo la chiamata; altamente consigliato utilizzare una nomenclatura del tipo NomeAzienda/NomeApplicativo 1.0 dove:
o NomeAzienda indica la ragione sociale del cliente (senza spazi e senza caratteri diversi da A-Z e 0.9)
o NomeApplicativo indica un nome di riferimento dell'applicativo o della procedura che sta utilizzando le API
o 1.0 indica la versione dell'applicativo
· Accept-Language: Culture, tra quelle supportate da PEOPLELINK, da utilizzare per nelle response. Il default è it-IT
· Accept-Encoding: indica l'encoding da utilizzare nella risposta; altamente consigliato impostarlo su gzip per ridurre la dimensione dei dati scambiati.
Altri parametri possono essere richiesti in base alle necessità dell'endpoint, principalmente per gli endpoint in GET.
Il Request body, presente negli endpoint di tipo POST, descrive invece il contenuto da inviare nel corpo della richiesta. Il tipo di contenuto, come application/json oppure application/x-www-form-urlencoded, fa parte del contratto dell'API: non è una preferenza liberamente sostituibile dal client. Il body può essere composto da uno o più elementi e nello schema vengono indicati, per ognuno, il nome, il tipo l'eventuale formato, l'indicazione di obbligatorietà, una descrizione funzionale, eventuali valori di esempio, di default o consigliati.
La sezione Example value, disposta alla sinistra dello Schema, aiuta a capire la forma dei dati, ma non va copiato senza sostituire i valori dimostrativi e verificare i requisiti. Per distinguere campi obbligatori, valori ammessi e formati, usa lo schema e le descrizioni, non soltanto l'esempio visualizzato.
Risposte e interpretazione degli errori e dei warning
La sezione Responses documenta le risposte previste per l'operazione selezionata, indicando gli stati HTTP, le relative descrizioni, la struttura del corpo della risposta ed eventuali header. Queste informazioni descrivono il comportamento atteso dell'API e non rappresentano la risposta effettivamente ricevuta durante un test.
La colonna Code elenca gli stati HTTP documentati. Per le API PEOPLELINK, tali stati devono essere interpretati come segue:
· 200: restituito sia se la risposta è valida sia se vengono riscontrati errori; Lo stato HTTP 200, da solo, non garantisce quindi il successo dell'operazione. In questo caso, il campo statusCode presente nel corpo della risposta indica l'esito applicativo:
o 200: Esito positivo
o 400: Con errori
· 401: token mancante o non valido. Il corpo della risposta è da ignorare
· 429: troppe richieste inviate in un breve lasso di tempo. Limite di frequenza superato
· 500: errore interno del server. Il corpo della risposta è da ignorare
· Eventuali altri stati HTTP non documentati vanno sempre trattati come errori generali.
La colonna Description riporta la spiegazione dello stato HTTP e la documentazione del contenuto associato. Comprende lo schema della risposta, con la struttura delle proprietà, i nomi dei campi, i tipi di dato, i formati e le descrizioni funzionali. Quando previsti, oltre al corpo della risposta, alcune operazioni delle API PEOPLELINK possono restituire specifici header HTTP contenenti informazioni utili per la gestione dell'integrazione. Gli header non devono essere interpretati come parte del JSON restituito dall'API: appartengono alla risposta HTTP e devono quindi essere letti separatamente dal client. La loro presenza dipende dallo stato HTTP restituito e dalla condizione che si è verificata. Le API PEOPLELINK possono restituire i seguenti Header in response:
· Warning: segnala la deprecazione del token e informa di pianificarne la sostituzione
· Sunset: indica che sull'utenza è stata indicata una scadenza e che è necessario pianificare il rinnovo delle credenziali prima della data indicata
· X-RateLimit-Limit: indica il limite massimo di chiamate consentite alle API in un determinato lasso di tempo
· X-RateLimit-Remaining: indica il numero di richieste alle API ancora disponibili prima di raggiungerne il massimo in un determinato lasso di tempo
· Retry-After: indica il numero di secondi da attendere prima che il rate limit si azzeri.
La colonna Links non è rilevante ai fini dell'integrazione e può essere ignorata.
Gli snippet di codice
Gli snippet sono frammenti di codice che mostrano come costruire una chiamata. Servono a passare dalla descrizione dell'API a una possibile implementazione nel proprio ambiente di sviluppo.
Lo Swagger PEOPLELINK mette a disposizione, su ogni endpoint, una sezione denominata Code snippets, con una serie di opzioni standard tra applicativi e linguaggi di programmazione. Al clic sul pulsante specifico, viene mostrato il rispettivo codice di esempio, con destinazione e metodo compilati sulla base del server selezionato, segnaposti e dei dati di esempio per gli Header, le QueryString, il Path e/o il Body. Gli snippet gestiti dallo swagger PEOPLELINK sono:
· Postman
· cURL
· C# (HttpClient)
· Python
· Kotlin
· Javascript (fetch)
· Javascript (jQuery)
Considera lo snippet come un punto di partenza, non come un'integrazione pronta per la produzione. Nel codice applicativo prevedi anche la corretta gestione delle rate limit, timeout, controllo degli errori e protezione dei segreti. Verifica, quindi, che quella rappresentazione contenga i valori desiderati.