Come testare le API di Openapi senza essere un Developer (Guida per Dummies)

Ti interessa verificare come funzionano le nostre API, quali dati sono disponibili per un’azienda o un immobile e non vuoi richiedere il supporto degli sviluppatori? Nessun problema, segui la nostra guida e potrai testare le nostre API in pochi secondi. Pur non conoscendo nulla di codice!

La funzionalità che ti aiuterà è "Try It Out" ed è disponibile nell’area Console, in tutti gli endpoint.

Registrati, prima di tutto!

Per poter utilizzare le nostre API se non l’hai ancora fatto, dovrai prima di tutto registrarti. 

 

 

Una volta completata la registrazione effettua il login e, se non ci sei già, vai sul portale Console, dove è presente la documentazione tecnica per integrare le nostre API e la funzionalità Try It Out per testare le API.

Scegli, Attiva API e Crea Token

Per iniziare gli step principali sono i seguenti:

1) Scegli l'API di tuo interesse nella sezione Libreria (per velocizzare la ricerca puoi filtrare le API per categorie)

2) Attiva l'API attraverso un click sul pulsante Attiva e segui le indicazioni

Per alcuni servizi ti potrà essere richiesto di effettuare l’autenticazione a due fattori o inserire un documento d’identità (una volta attivata la prima API, per la maggior parte delle restanti dovrai solo cliccare su "Attiva" per renderle operative)

3) Crea il Token per autenticarti

Se le API che cerchi non prevedono le chiamate gratuite, allora prima di procedere ricarica il tuo credito. 

Se invece hai verificato che le API di tuo interesse includono chiamate gratuite potrai passare direttamente a generare il tuo primo token, una forma di password che ti servirà per autenticarti ed utilizzare in sicurezza le API.  

Per creare il tuo primo token puoi utilizzare:

• il tool dedicato Nuovo token (Sandbox) presente nella sezione Autenticazione

 

 

• l’endpoint Post /Token dell’API Oauth. In questo caso caso dovrai utilizzare l’APIKey Sandbox disponibile nella sezione Autenticazione

 

 

Copia il Token, una serie di caratteri alfanumerici, che hai generato perché a breve dovrai utilizzarlo. 

Sei pronto/a per la tua prima Chiamata

Utilizzeremo come esempio della nostra prima chiamata le API Company, in particolare l’endpoint GET /IT-advanced/{vatCode_taxCode_or_id} che è tra i più utilizzati ed è “sincrono”, cioè offre i risultati in tempo reale.

Company Advanced Partita IVA consente da un parametro (ad es. la Partita IVA) di ottenere una serie di informazioni sull’azienda come ad esempio indirizzo della sede legale, PEC, fatturato ed utile degli ultimi tre anni e numero dipendenti. Altri endpoint potrebbero chiedere i dati catastali di un immobile oppure il codice fiscale di un soggetto.

Verifica che il server sia impostato in Production (e non in Sandbox) per ottenere i dati reali e non utilizzare l’ambiente test.

 

 

Adesso è arrivato il momento di utilizzare il token che abbiamo creato e procedere all’autenticazione. Clicca sul Pulsante Authorize e nel campo Value inserisci il token, poi clicca su Close. 

 

Dopo aver completato la procedura di autenticazione, clicca sull’endpoint desiderato (GET /IT-advanced/{vatCode_taxCode_or_id) e si aprirà la sezione dedicata.

A destra diventerà visibile il pulsante Try it Out, che è la funzionalità per provare la chiamata.

I parametri di ricerca per il Get Company Advanced sono VAT number, tax code o ID. Utilizzeremo il VAT number, cioè la partita IVA dell’impresa oggetto della nostra verifica.

Inserisci quindi la partita IVA e clicca sul pulsante Execute.

 

La tua chiamata è stata inviata e, se scorri in basso nella sezione Responses > Response Body, troverai la risposta alla tua richiesta con tutti i dati disponibili dell’azienda. I dati sono strutturati in Json, un semplice formato per lo scambio di dati, facilmente leggibile.   

Sono i dati di cui avevi bisogno? Contatta il tuo sviluppatore per avviare la procedura di integrazione. 

Hai dubbi su dati o hai bisogno di altre informazioni e non riesci a trovarle sul sito? Non esitare a contattarci per sapere come le nostre API possono aiutare il tuo business.