Annuncio della CLI di IDlayr

by Paul McGuire | Marzo 2, 2021
La CLI tru.ID

In quanto azienda orientata agli sviluppatori e alle API, diamo priorità agli strumenti che consentono a voi, gli sviluppatori, di avere successo. Oggi siamo entusiasti di annunciare la CLI di IDlayr: costruita sulla base delle nostre API pubbliche, open source, e strumento di sviluppo ideale per chi costruisce su IDlayr. IDlayr piattaforma.

Perché una CLI?

Molti di noi passano molto tempo nel terminale, quindi una CLI vi permette di lavorare da dove siete già. IDE come Visual Studio Code e Android Studio sono dotati di terminali integrati. Ma avere una CLI ci permette anche di creare integrazioni nei flussi di lavoro di sviluppo esistenti, tramite script, al di fuori dell'IDE. Ad esempio, Comportamenti di Xcode o l'integrazione nei flussi di lavoro CI/CD.

Utilizzo di Oclif e Open Source

Il IDlayr CLI si basa sull'eccellente Il framework open CLI oclif di Heroku. Oclif fornisce una base per le funzionalità della CLI, come i sottocomandi, gli argomenti e i flag dei comandi, il supporto per i plugin e molte utilità che ci permettono di concentrarci sulle funzionalità invece di costruire il nostro framework CLI.

Se desiderate vedere come abbiamo utilizzato Oclif, il sito IDlayr CLI è su GitHub. All'interno del repo GitHub si trovano due rami:

  • `main` per l'ultima versione stabile
  • `canary` se si vogliono provare le ultime funzionalità

Ci piacerebbe sapere cosa ne pensate, quindi vi invitiamo a fare domande, condividere idee e sollevare questioni di PR su Repo IDlayr/cli.

Installare e configurare il sistema IDlayr CLI

Per il momento l'unica opzione di installazione è tramite NPM, quindi è necessario avere Node.js installato.

Con Node.js installato, si installa il file IDlayr CLI come segue:

Oppure, se preferite Filato:

Per provare le ultime funzionalità, utilizzare `@tru_id/cli@canary`.

Con il comando `tru` installato, configurare la CLI con le credenziali che si trovano nel file IDlayr console.

`eu` è la regione in cui sono memorizzati i dati del vostro account e, al momento di questo post, è l'unica regione disponibile (presto ne arriveranno altre).

Ora è possibile interrogare il credito disponibile utilizzando:

L'output sarà simile a:

Creare un IDlayr Progetto

I progetti sono contenitori di configurazione all'interno della cartella IDlayr e di solito si ha una mappatura uno-a-uno di un progetto IDlayr con un'applicazione che si sta sviluppando (anche se si può creare un progetto per ogni ambiente: `dev`, `staging` e `prod`). Un elemento chiave della configurazione sono le `credenziali` del progetto, che contengono un `client_id` e un `client_secret` che si usano per autenticare le interazioni con le API di IDlayr.

I progetti vengono creati tramite la CLI:

E si vedranno risultati come:

Il file `tru.json` contiene la configurazione del progetto, comprese le credenziali del progetto. Non inserire questo file nel controllo sorgente!

Una volta creato il progetto, si può fare `cd my_awesome_project`, in modo che la CLI possa leggere il file `tru.json` dalla `cwd` e si ha tutto ciò che serve per utilizzare appieno il programma IDlayr CLI.

Provare le API di IDlayr

Le CLI si concentrano normalmente sulle funzionalità di gestione della piattaforma, come la creazione e la gestione dei progetti, ma abbiamo deciso di aggiungere anche dei comandi che consentono di provare i nostri prodotti dal terminale. Naturalmente, è possibile provarli anche in modo programmatico.

SIMCheck

SIMCheck è un'API che chiede quando la carta SIM associata a un numero di telefono è stata cambiata l'ultima volta:

Il risultato è simile al seguente, che richiede la verifica del numero di telefono:

Il valore `no_sim_change` indica che la carta SIM non è stata cambiata negli ultimi sette (7) giorni, mentre `last_sim_change_at` specifica la data dell'ultima modifica (quando ho cambiato il mio gestore di telefonia mobile da giffgaff UK a EE UK).

Controllo del telefono

PhoneCheck verifica che un numero di telefono sia associato a una carta SIM all'interno del dispositivo mobile. Ciò avviene grazie all'integrazione di IDlayr con gli MNO (Mobile Network Operator) di tutto il mondo. Per uno sguardo più approfondito sul funzionamento di questo sistema, consultate il documento Guida all'integrazione di PhoneCheck. Naturalmente, è possibile provarlo anche tramite la nostra CLI:

L'output di questo comando richiede un numero di telefono e visualizza anche un codice QR da scansionare su un dispositivo mobile. Fornisce inoltre le istruzioni per disabilitare il WiFi sul dispositivo, poiché parte del flusso di lavoro di PhoneCheck consiste nell'effettuare una richiesta web tramite la connessione dati mobile del dispositivo.

Codici QR nel terminale. Davvero bello, eh!

Oltre a creare risorse, è possibile interrogare quelle esistenti:

Si può anche provare `tru phonechecks:list` con flag come `-search` per aggiungere condizioni di interrogazione alla richiesta API, `-filter` per filtrare un risultato dall'API e `-output` per cambiare il formato di output, ad esempio `-output json`.

Controllo abbonati

La CLI supporta anche Controllo abbonatiche esegue un PhoneCheck ma include anche un SIMCheck nel risultato. Lasciamo a voi il compito di provarlo, ma ecco il comando di creazione che viene eseguito attraverso il flusso di lavoro del codice QR:


Cos'altro può fare la CLI?

Altri due comandi che vale la pena sottolineare sono `oauth2` e `coverage`.

OAuth2

Le nostre API utilizzano credenziali OAuth2 e token di accesso per l'autenticazione. Ma sappiamo che a volte si vuole semplicemente accedere a un token di accesso senza dover concatenare un `client_id` e un `client_secret` di progetto, codificare Base 64 questo valore, fare una richiesta al servizio endpoint `/token per creare un token di accesso, per poi arrivare a usarlo. Quindi, il comando `oauth2` rende un po' più semplice la creazione di un token di accesso quando si stanno facendo delle prove.

Nota: l'esecuzione del comando seguente da una directory che contiene un file di configurazione del progetto `tru.json` utilizzerà le credenziali del progetto. Se si esegue il comando senza un file `tru.json` nella `cwd`, si useranno le credenziali fornite nel comando `tru setup:credentials`.

È sufficiente copiare il token di accesso e utilizzarlo:

È anche possibile assegnare l'output a una variabile e utilizzarlo in un client mobile o per fare delle prove tramite cURL:

Copertura

Copertura fornisce due punti finali ed è quindi un "argomento" con due comandi nella CLI.

`copertura:paese {codice_paese}` permette di chiedere se il IDlayr La piattaforma ha una copertura per un determinato Paese. È possibile utilizzare un numero di telefono prefisso del paese:

O un codice paese di due lettere alfa:

`coverage:reach` esegue anche un'operazione di IDlayr La richiesta di copertura della piattaforma è basata sull'indirizzo IP (IPv4 o IPv6) del dispositivo:

Provate la CLI e fateci sapere cosa ne pensate

In questo post abbiamo trattato alcuni dei comandi principali, ma la CLI offre molto di più. Installate il programma IDlayr CLI (`npm install -g @tru_id/cli`) e `tru -help` per saperne di più, oppure date un'occhiata al file Documentazione di riferimento della CLI per vedere cos'altro è possibile fare.

Riteniamo che il IDlayr CLI offre una buona prima esperienza di sviluppo della nostra piattaforma. Ma ci piacerebbe sapere cosa ne pensate via [email protected].

Se non l'avete ancora fatto, iscriversi a un IDlayr conto, segui @theidlayr su X e unisciti alla nostra missione di reimmaginare l'autenticazione mobile.