Presentazione dell'API di analisi di tru.ID

by Paul McGuire | Febbraio 8, 2023
Presentazione dell'API di analisi tru.ID

Che cos'è l'API di Analytics?

Il API di analisi è una nuova funzionalità rilasciata da tru.ID. Questa funzione è stata creata per consentire a coloro che hanno accesso al tru.ID Workspace di esportare direttamente i dati di analisi e reporting.

‍

Le API tru.ID confermano la proprietà di un numero di telefono cellulare verificando il possesso di una carta SIM attiva con lo stesso numero, funzionando come prova di possesso per l'autenticazione a più fattori (MFA).

‍

La nuova API di analisi fornisce principalmente dati per determinare il tasso di controlli riusciti e falliti.

Dove posso vedere l'API in azione?

L'API di Analytics è stata implementata nella vostra Console per sviluppatori per facilitare l'accesso se non si desidera utilizzare l'API stessa. Tuttavia, tutte le funzionalità mostrate nella Developer Console e altre ancora sono disponibili con l'API.

‍

Di seguito è riportato un esempio di API di Analytics integrata nel vostro sito web Console per sviluppatori. Questo permette a chi ha accesso all'area di lavoro di vedere le statistiche sulla Prodotto di loro scelta (PhoneCheck, SubscriberCheck o SIMCheck), con l'opzione layout di loro scelta (oraria, giornaliera o mensile), e sulla base della tempo periodo di loro scelta.

‍

‍

Sotto il grafico Analytics nella Console sviluppatori, si trova una tabella che fornisce ulteriori informazioni sulla ripartizione delle statistiche del PhoneCheck. Questa tabella è raggruppata per progetto e fornisce uno dei 4 risultati possibili per ogni progetto:

‍

  • COMPLETATO (Il numero di telefono corrisponde)
  • COMPLETATO (Il numero di telefono non corrisponde)
  • SCADUTO (L'URL di controllo univoco è stato attivato ma non è mai stato completato)
  • ERRORE (Ciò potrebbe essere dovuto al fatto che l'operatore di rete mobile (MNO) non è supportato o che il dispositivo non ha un indirizzo IP mobile).

‍

Un esempio di risultati API

‍

Come posso utilizzare l'API?

L'API di Analytics si trova sotto la voce Specifiche API all'interno del tru.ID Portale della documentazione per sviluppatori.

‍

Esistono tre endpoint distinti per questa API. Ogni endpoint ha a disposizione gli stessi parametri. L'ultima parte dell'URL dell'endpoint specifica quale si desidera utilizzare:

‍

  • Orario (`/orario`)
  • Giornaliero (`/giorno`)
  • Mensile (`/mese)`)

Un esempio di richiesta di analisi è mostrato nell'URL sottostante. Questa verifica la presenza di Analytics mensili su PhoneCheck (`pck`), dove `match` è vero e i risultati sono raggruppati per `project_id`.

‍

‍

Accesso all'API di Analytics tramite CLI

È possibile accedere all'API di Analytics anche dall'interfaccia a riga di comando di IDlayr. La panoramica dettagliata si trova nella sezione Riferimento all'interfaccia a riga di comando (CLI) all'interno del IDlayr Portale della documentazione per sviluppatori.

‍

Analogamente all'API, per accedere ai dati di analisi, ci sono due parametri - un prodotto e un bucket temporale - che devono essere specificati dopo l'opzione `analytics:` il prefisso del comando:

dove

  • PRODOTTO = `pck | sck |suk`
  • CESTINO DEL TEMPO = `Orario | Giornaliero | Mensile`

‍

Un esempio di accesso alle analisi dalla CLI di IDlayr è mostrato nel comando seguente. Questo controlla le analisi mensili su PhoneCheck (`pck`), dove `match` è vero e i risultati sono raggruppati per `project_id`.

‍

‍

Questo è tutto ciò che occorre sapere per iniziare a utilizzare l'API di Analytics e cominciare ad analizzare efficacemente i dati di tru.ID.

‍

Se avete domande, non esitate a contattare [email protected] o partecipare al nostro gruppo Slack dedicato.