Avvio rapido delle API

Avvio rapido delle API di MioCodiceFiscale.it

Questa guida ti fornirà tutto ciò di cui hai bisogno per iniziare a utilizzare le API di MioCodiceFiscale.it per calcolare il codice fiscale, per verificarne la validità e altro ancora. Analizzeremo la generazione della chiave API, la gestione della lingua preferita e la prima chiamata API, una semplice richiesta all'endpoint Ping.

Genera la tua chiave API

Il modo più semplice per autenticare una richiesta alle API di MioCodiceFiscale.it è utilizzare una chiave API.

Ecco come puoi generarne una:

  • Clicca sul pulsante Genera Chiave API
  • Inserisci il dominio del sito internet che effettuerà la chiamata alle API
  • Inserisci una email di contatto valida
  • Clicca sul pulsante Ricevi Chiave API tramite email

Sarà così generata la tua Chiave API (access_token).

L'utilizzo delle API di MioCodiceFiscale.it è gratuito fino a un massimo di 1000 chiamate giornaliere per account.
Per esigenze superiori, è possibile richiedere un piano personalizzato contattandoci via email all’indirizzo info@miocodicefiscale.it.
Offriamo inoltre un servizio professionale di analisi su grandi volumi di dati, interamente gestito dal nostro team. Contattaci per richiedere un preventivo.
Nota: è importante ricordare che la tua Chiave API fornisce l'accesso completo ai servizi a te dedicati; quindi, dovresti tenerla al sicuro come faresti con una password.

Gestione della lingua

La lingua di default delle risposte delle API di MioCodiceFiscale.it è l'italiano

E' possibile tuttavia, ricevere i messaggi delle risposte API in altre lingue.

Puoi effettuare chiamate alle API di MioCodiceFiscale.it, con il metodo che utilizzi abitualmente per effettuare richieste HTTP.

Esempio:
http://api.miocodicefiscale.it/{lingua}/...
Campi:
Se omesso il valore {lingua}, la lingua di default è l’italiano.
Campo Descrizione Valori consentiti
{lingua}
Stringa di testo
Il codice della lingua con cui si vuole gestire le risposte delle chiamate API Italiano: it
Inglese: en
Rumeno: ro
Arabo: ar
Cinese (semplificato): zh

Nota: il valore va indicato in minisculo.

Effettua la tua prima chiamata API (Ping Test)

Per verificare che tutto sia impostato correttamente e che la Chiave API sia funzionante, faremo una semplice richiesta all'endpoint Ping. Il raggiungimento di questo endpoint funge da controllo dello stato del servizio API di MioCodiceFiscale.it; non influirà quindi in alcun modo sul tuo account.

Esempio:
http://api.miocodicefiscale.it/ping?access_token={tua-chiave-API}
Campi:
I campi su indicati sono tutti obbligatori.
Campo Descrizione Valori consentiti
access_token
Stringa di testo
La tua chiave API Nessun vincolo
Risposta:

Se tutto è stato impostato correttamente e la richiesta di ping è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Le chiamate API funzionano correttamente!"
}
                
Campo Descrizione Valori della risposta
status Indica la validità della chiamata all’endepoint PING Boolean
Chiamata valida: true
Chiamata non valida: false
message Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato. Stringa di testo
Sostieni questo progetto

Sei giunto sul nostro sito numerose volte e lo consideri utile? Aiutaci a tenerlo attivo. Versando un piccolo contributo puoi contribuire alle spese di hosting e di traffico. Ogni contributo, anche minimo, è benaccetto. Dona tramite PayPal o tramite Stripe (carta di credito), la tua collaborazione è preziosa! Grazie.

PAGACI UN CAFFÈ

PAYPAL CREDIT CARD

Sostieni questo progetto

Sei giunto sul nostro sito numerose volte e lo consideri utile? Aiutaci a tenerlo attivo. Versando un piccolo contributo puoi contribuire alle spese di hosting e di traffico. Ogni contributo, anche minimo, è benaccetto. Dona tramite PayPal o tramite Stripe (carta di credito), la tua collaborazione è preziosa! Grazie.

PAGACI UN CAFFÈ

PAYPAL STRIPE