Anuncio de IDlayr CLI

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

Como empresa que da prioridad a los desarrolladores y a las API, damos prioridad a las herramientas que harán que usted, el desarrollador, tenga éxito. Hoy estamos encantados de anunciar la CLI IDlayr: construido en la parte superior de nuestras API públicas, de código abierto, y su ir a la herramienta de desarrollador cuando se construye en el IDlayr plataforma.

¿Por qué una CLI?

Muchos de nosotros pasamos mucho tiempo en el terminal, así que una CLI te permite trabajar desde donde ya estás. IDEs como Visual Studio Code y Android Studio vienen con terminales incorporados. Pero tener una CLI también nos permite crear integraciones en los flujos de trabajo de desarrollo existentes, a través de scripts, fuera del IDE. Por ejemplo, Comportamientos de Xcode o la integración en flujos de trabajo CI/CD.

Oclif y el código abierto

En IDlayr CLI se basa en el excelente oclif open CLI framework de Heroku. Oclif proporciona una base para la funcionalidad CLI como subcomandos, argumentos de comandos y banderas, soporte de plugins y un montón de utilidades que nos permiten centrarnos en las características en lugar de construir nuestro propio marco CLI.

Si desea ver cómo hemos utilizado Oclif el IDlayr CLI está en GitHub. En el repositorio de GitHub encontrarás dos ramas:

  • `main` para la última versión estable
  • `canary` si quieres probar las últimas funciones

Nos encantaría conocer su opinión, así que no dude en hacer preguntas, compartir ideas y plantear RR. Repo IDlayr/cli.

Instalar y configurar el IDlayr CLI

Por el momento, la única opción de instalación es a través de NPM, por lo que necesitarás tener instalado Node.js.

Con Node.js instalado se instala el archivo IDlayr CLI como sigue:

O, si lo prefiere Hilo:

Para probar las últimas funciones, utilice `@tru_id/cli@canary`.

Con el comando `tru` instalado, configure la CLI con las credenciales que encontrará en el archivo IDlayr consola.

eu" es la región en la que se almacenan los datos de su cuenta y, en el momento de publicar este blog, es la única región que tenemos disponible (pronto habrá más).

Ahora puedes consultar el crédito que tienes disponible utilizando:

Y la salida será similar a:

Creación de una IDlayr Proyecto

Los proyectos son contenedores de configuración dentro de IDlayr y normalmente tendrás un mapeo uno a uno de un proyecto IDlayr a una aplicación que estés desarrollando (aunque también puedes crear un proyecto por entorno: `dev`, `staging` y `prod`). Una pieza clave de la configuración son las `credenciales` del proyecto que contienen un `client_id` y un `client_secret` que se utilizan para autenticar las interacciones con las APIs de IDlayr.

Los proyectos se crean mediante la CLI:

Y verás resultados como:

El archivo `tru.json` contiene la configuración de tu proyecto incluyendo las credenciales del proyecto. No lo registres en el control de código fuente.

Con un proyecto creado puede `cd my_awesome_project` por lo que la CLI puede leer el archivo `tru.json` de la `cwd` y tienes todo lo necesario para utilizar plenamente la IDlayr CLI.

Probar las API de IDlayr

Las CLI normalmente se centran en la funcionalidad de gestión de la plataforma, como la creación y gestión de proyectos, pero hemos decidido añadir también comandos para que puedas probar nuestros productos desde el terminal. Por supuesto, también puedes probarlos mediante programación.

SIMCheck

SIMCheck es una API que consulta cuándo cambió por última vez la tarjeta SIM asociada a un número de teléfono:

La salida es similar a la siguiente, en la que se solicita el número de teléfono que se desea comprobar:

El valor `no_sim_change` indica que la tarjeta SIM no ha cambiado en los últimos siete (7) días, y `last_sim_change_at` especifica la fecha del último cambio (cuando cambié mi proveedor de telefonía móvil de giffgaff UK a EE UK).

PhoneCheck

PhoneCheck verifica que un número de teléfono está asociado a una tarjeta SIM dentro del dispositivo móvil. Esto se consigue a través de la integración de IDlayr con MNOs (Mobile Network Operators) de todo el mundo. Para conocer más a fondo cómo funciona, consulte la página Guía de integración de PhoneCheck. Por supuesto, también puede probarlo a través de nuestra CLI:

La salida de este comando solicita un número de teléfono y también muestra un código QR para escanear en un dispositivo móvil. También proporciona instrucciones para desactivar el WiFi en el dispositivo, ya que parte del flujo de trabajo de PhoneCheck consiste en realizar una solicitud web a través de la conexión de datos móviles del dispositivo.

Códigos QR en el terminal. Muy chulo, ¿eh?

Además de crear recursos, también puede consultar los existentes:

También puede probar `tru phonechecks:list` con opciones como `-search` para añadir condiciones de consulta a la solicitud de la API, `-filter` para filtrar un resultado de la API y `-output` para cambiar el formato de salida, por ejemplo, `-output json`.

Comprobación de abonados

La CLI también admite Comprobación de abonadosque ejecuta un PhoneCheck pero también incluye un SIMCheck en el resultado. Dejaremos que lo pruebes tú, pero aquí está el comando de creación que se ejecuta a través del flujo de trabajo del código QR:


¿Qué más puede hacer la CLI?

Otros dos comandos que merece la pena destacar son `oauth2` y `coverage`.

OAuth2

Nuestras API utilizan credenciales OAuth2 y tokens de acceso para la autenticación. Pero sabemos que a veces sólo quieres acceder a un token de acceso sin tener que concatenar un `client_id` y un `client_secret` de proyecto, codificar en Base 64 ese valor, hacer una petición a la API punto final `/token para crear un token de acceso, y luego eventualmente llegar a usarlo. Por lo tanto, el comando `oauth2` hace que sea un poco más fácil crear un token de acceso cuando estás probando cosas.

Nota: Ejecutar el siguiente comando desde un directorio que contenga un archivo de configuración de proyecto `tru.json` utilizará las credenciales del proyecto. Si ejecutas el comando sin un `tru.json` en el `cwd` usarás las credenciales que proporcionaste en el comando `tru setup:credentials`.

A continuación, sólo tiene que copiar el token de acceso y utilizarlo:

También puede asignar la salida a una variable y utilizarla en un cliente móvil o para probar cosas a través de cURL:

Cobertura

Cobertura proporciona dos puntos finales y es, por tanto, un "tema" con dos comandos en la CLI.

`cobertura:país {código_país}` permite consultar si el IDlayr tiene cobertura para un país determinado. Puede utilizar un número de teléfono prefijo del código de país:

O un código de país de dos letras alfa:

`cobertura:alcance` también realiza una IDlayr consulta de cobertura de la plataforma, sino en función de la dirección IP (IPv4 o IPv6) del dispositivo:

Pruebe la CLI y díganos qué le parece

En este post hemos cubierto una serie de los principales comandos, pero hay más que la CLI ofrece. O bien instalar el IDlayr CLI (`npm install -g @tru_id/cli`) y `tru -help` para obtener más información, o eche un vistazo a la sección Documentos de referencia de la CLI para ver qué más es posible.

Creemos que el IDlayr CLI ofrece una buena primera experiencia de nuestra plataforma a los desarrolladores. Pero nos encantaría saber lo que piensa a través de [email protected].

Si aún no lo has hecho, inscribirse en un IDlayr cuenta, sigue a @theidlayr en X y únase a nuestra misión de reimaginar la autenticación móvil.