Ti interessa verificare come funzionano le nostre API, quali dati sono disponibili per un’azienda/un privato 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 esamineremo in questa guida è "Try It Out (Swagger UI)", disponibile nella nostra Console (per tutti gli endpoint).

Ti è utile sapere che per i tuoi test potrai utilizzare in alternativa anche l'area Playground - disponibile per alcune API - o la piattaforma Postman.

Vediamo ora nel dettaglio come funziona Try It Out (Swagger UI).

Registrati, prima di tutto!

Per poter utilizzare le nostre API se non l’hai ancora fatto, dovresti 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 (Swagger UI) 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 potrà esserti 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 l'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 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!

Come ti anticipavamo all'inizio, puoi fare i tuoi test anche attraverso l'area Playground, disponibile per alcune API (ad es. Firma Digitale e in particolare il servizio Firma Elettronica, di cui ti abbiamo parlato in questo articolo) o la piattaforma Postman.

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