Postman
Per testare la nostra API senza scrivere una sola riga di codice, abbiamo utilizzato la nostra OpenAPI Specification per generare una Postman Collection dedicata.
Postman è una piattaforma per costruire e utilizzare le API. Le Postman Collection possono descrivere tutti i metodi esposti da un'API, permettendo all'utente di modificare i diversi parametri di richiesta ed eseguire chiamate reali verso le API, ottenendo come risultato una risposta HTTP (response).
0 - Installazione Postman
Per utilizzare la nostra collection, suggeriamo di scaricare Postman sul tuo dispositivo; è disponibile per Windows, Mac e Linux.
Successivamente, registrati a Postman: non preoccuparti, per utilizzare la nostra collection è sufficiente il Piano Gratuito 😉
1 - Importazione della Collection
Clicca sul pulsante in basso per eseguire la collection direttamente in Postman:
2 - Copia della Collection tramite fork
Ora sei quasi pronto per interagire con la nostra API!
Non sei soddisfatto della nostra collection? Se preferisci, puoi invece utilizzare direttamente la nostra OpenAPI Specification, importando i file .yaml utilizzando questa procedura. Devi solo assicurarti di scaricare anche i file nella cartella models, altrimenti l'importazione fallirà. Inoltre, devi selezionare i parametri corretti per importare correttamente la collection.
3 - Autorizzazione
Successivamente, per poter interagire con la nostra API devi essere autorizzato: consulta la pagina Authentication per ulteriori informazioni.
Hai due opzioni principali per recuperare un token valido:
-
OAuth 2.0 Manuale: se vuoi testare il passaggio di autenticazione, puoi provare a recuperare il token e utilizzarlo direttamente con Postman. Una volta recuperato un token valido, infatti, puoi semplicemente inserirlo come token Bearer seguendo questa procedura.
-
OAuth 2.0 Automatico con Postman: utilizzando il modello di autenticazione standard nativo in Postman.
Di seguito un esempio dell'opzione 2, che mostra come utilizzare Postman per recuperare automaticamente il tuo Access Token dalla sua interfaccia. Per procedere alla configurazione, clicca sulla collection e seleziona la scheda Authorization, quindi compila la form Configure New Token.
I parametri possono essere, ad esempio:
- grant_type: token
- username: parametro ricevuto
- token: parametro ricevuto
- Access-Control-Allow-Origin: http://localhost:3000
- password: null
- scope: parametro ricevuto
- web_base_url: parametro ricevuto
Una volta completata la configurazione, cliccare su Get New Access Token, e dopo aver ottenuto l'autorizzazione l'interfaccia di Postman chiede se salvare il token per i successivi utilizzi.
4 - Test della nostra API
Sei finalmente pronto per provare la nostra API utilizzando Postman. Seleziona il metodo che vuoi provare, compila i parametri della request, clicca sul pulsante Send e il gioco è fatto!
Recupera l'ID della tua ditta! Molti dei nostri metodi sono limitati alla ditta, il che significa che richiedono di indicare il Company ID su cui stiamo operando. La buona notizia è che puoi usare Postman per recuperarlo! Controlla la pagina Company-scoped Methods per maggiori informazioni.
5 - Aggiornamento della Collection
In caso di modifiche alla collection pubblicata, vengono inviate notifiche tramite e-mail.
Puoi aggiornare la tua collection all'ultima versione effettuando una Pull request da Postman.