Español
  • logto
  • management-api
  • api
  • machine-to-machine
  • organization
  • user-profile
  • user-search
  • audit-log
  • migration

Explorando todo el potencial de la API de Gestión de Logto

En este artículo, volvemos a enfatizar la definición de la API de Gestión de Logto, explicamos cómo funciona y mostramos escenarios típicos para aumentar tu productividad y desbloquear más casos de uso.

Guamian
Guamian
Product & Design

Como un servicio de infraestructura, nos esforzamos por hacer que el uso de nuestra API de Gestión de Logto sea más fácil y rápido. Recientemente hemos actualizado nuestras guías y tutoriales. En este artículo, volvemos a enfatizar la definición de la API de Gestión de Logto, explicamos cómo funciona y mostramos escenarios típicos para aumentar tu productividad y desbloquear más casos de uso.

¿Qué es la API de Gestión de Logto?

La API de Gestión de Logto es un potente conjunto de APIs preconstruidas que brinda a los desarrolladores control total para personalizar su implementación según sus necesidades de producto y stack tecnológico.

Está incluida en la lista de recursos de la API y no se puede eliminar ni modificar. Todo lo que puedes hacer en la Consola de Administración de Logto también se puede hacer con la API de Gestión de Logto.

Su identificador sigue el patrón de https://[tenant-id].logto.app/api

API de gestión de Logto

API de gestión de Logto - 2

Incluye todos los permisos por defecto. A medida que Logto crece, seguiremos haciendo los permisos más granulares.

Con la API de Gestión de Logto, puedes acceder a los robustos servicios backend de Logto, que son altamente escalables y pueden ser utilizados en una multitud de escenarios. Para conocer las APIs disponibles, por favor visita Referencias de la API de Logto.

Escenarios típicos para usar la API de gestión

Nuestros desarrolladores han implementado muchas características adicionales usando nuestra API de Gestión. Creemos que nuestra API es altamente escalable y puede soportar una amplia variedad de tus necesidades. Aquí hay algunos ejemplos de escenarios que no son posibles con la Consola de Administración de Logto, pero que se pueden lograr a través de la API de Gestión.

Implementar perfil de usuario con tu UI personalizada

Logto actualmente no proporciona una solución de UI preconstruida para perfiles de usuario. Reconocemos que los perfiles de usuario están estrechamente ligados a los atributos del negocio y el producto. Mientras trabajamos en determinar el mejor enfoque, sugerimos usar nuestras APIs para crear tu propia solución. Por ejemplo, puedes utilizar nuestra API de interacción, API de perfil y API de código de verificación para desarrollar una solución personalizada que se ajuste a tus necesidades. Hemos preparado una página dedicada Perfil de Usuario con tutoriales y guías.

Un ejemplo interesante es que la función de perfil de usuario de Logto Cloud está construida utilizando la API de Gestión de Logto.

Configuraciones de la cuenta

Implementar gestión de organizaciones con tu UI personalizada

Si estás usando la función de organización para construir tu app multi-tenant, podrías necesitar la API de gestión de Logto para tareas como invitaciones a la organización y gestión de miembros.

De igual manera, la función de invitación y colaboración de Logto Cloud está construida utilizando la API de Gestión de Logto también.

Organización

Invitar miembros a la organización

Para extender ese caso, para tu producto SaaS, donde tienes tanto administradores como miembros en el tenant, la API de gestión de Logto puede ayudarte a crear un portal de administración personalizado adaptado a las necesidades de tu negocio. Consulta esto para más detalles.

Búsqueda avanzada de usuarios

La Consola de Administración de Logto admite funciones básicas de búsqueda y filtrado. Si necesitas opciones más avanzadas para adaptar tu servicio de gestión de usuarios a las necesidades de tu negocio, puedes usar la API de Gestión de Logto. Esta admite opciones de búsqueda avanzada, tales como:

  1. Búsqueda difusa
  2. Coincidencia exacta
  3. Sensibilidad a mayúsculas
  4. Especificar campos

Consulta nuestros tutoriales y guías de Búsqueda avanzada de usuarios.

Utilizar los logs de Logto para construir tus propios servicios

El registro de auditoría de Logto te permite monitorear fácilmente la actividad y los eventos de los usuarios. Proporciona una base sólida para varios escenarios de gestión de usuarios y verificación de salud empresarial.

Registros de auditoría

Al utilizar la API de gestión, puedes acceder a datos de registro de auditoría en tiempo real. Esto te permite diseñar tu propio modelo de esquema y panel de control utilizando los datos de registros obtenidos de Logto.

Migrar e importar usuarios a Logto

Usar la API de Gestión puede ayudarte fácilmente a importar datos de usuarios, especialmente si deseas realizar una migración a Logto.

Después de preparar los datos de usuario y configurar el hashing de contraseñas y el esquema de usuario, configura la conexión de la API de Gestión y llamaremos a la API de crear usuario para importar los datos de usuario. Para obtener más información sobre la migración, consulta este documento.

Cómo acceder a la API de Gestión de Logto

Crear una app M2M

Selecciona el tipo de app M2M y comienza el proceso de creación. Después de la creación, serás dirigido a un módulo donde puedes asignar un rol de máquina a máquina.

Después de proporcionar un nombre y descripción, verás un módulo que te pide asignar un rol. Este módulo incluye todos los roles de M2M, los roles indicados por un ícono de Logto significan que estos roles incluyen permisos para la API de Gestión de Logto.

Asignar roles de M2M incluye permisos para la API de Gestión de Logto para tu app M2M.

Asignar rol M2M

¿Por qué usar comunicación de máquina a máquina y asignar roles de máquina a máquina?

¿Por qué Logto permite comunicación M2M (Máquina a Máquina) para llamar a la API de Gestión de Logto en lugar de usar claves de API?

Logto aborda la gestión de identidad de clientes y sigue estrictamente estándares abiertos como OAuth 2.0 y OpenID Connect. Los tokens M2M ofrecen interacciones seguras entre servidores con alcances específicos, proporcionando mejor seguridad que las claves de API estáticas. A diferencia de las claves de API, que no expiran y representan un mayor riesgo si son comprometidas, los tokens M2M tienen tiempos de expiración definidos, limitando la ventana para un uso indebido potencial.

En Logto, usamos control de acceso basado en roles (RBAC) para proteger y gestionar el acceso a la API de Gestión de Logto. Este diagrama de entidad muestra cómo funciona.

La relación de permisos, recursos de API, roles y aplicación máquina a máquina.

La relación de permisos, recursos de API, roles y aplicación máquina a máquina.

Obtener un token de acceso

Conceptos básicos sobre la solicitud de token de acceso

La app M2M realiza una solicitud POST al endpoint de token para obtener un token de acceso agregando los siguientes parámetros usando el formato application/x-www-form-urlencoded en el cuerpo de la solicitud HTTP:

  • grant_type: debe ser configurado como client_credentials
  • resource: el indicador de recurso al que deseas acceder
  • scope: El alcance de la solicitud de acceso

Y también necesitas incluir tus credenciales M2M para que el endpoint de token autentique tu app M2M. Esto se logra agregando un encabezado de Authorization usando Autenticación Básica, donde el nombre de usuario es el App ID y la contraseña es el App Secret.

Puedes encontrar el App ID y App Secret en la página de detalles de tu aplicación M2M:

Credenciales de la app

Un ejemplo de solicitud de token de acceso a la API de Gestión de Logto es:

Obtener token de acceso para la API de Gestión de Logto

Logto proporciona un recurso incorporado “Logto Management API”, es un recurso de solo lectura con el permiso todos para acceder a la API de Gestión de Logto, puedes verlo desde tu lista de recursos de API. El indicador de recurso de la API sigue el patrón de https://{YOUR_TENANT_ID}.logto.app/api , y este será tu valor de recurso utilizado en el cuerpo de la solicitud de token de acceso.

Estado de la API de gestión

Antes de acceder a la API de Gestión de Logto, asegúrate de que tu app M2M haya sido asignada con roles de M2M que incluyan el permiso todos de este recurso incorporado “Logto Management API”.

Ahora, compone todo lo que tenemos y envía la solicitud:

Respuesta del token

Un cuerpo de respuesta exitoso sería así:

Acceder a la API de Gestión de Logto usando el Token de Acceso

Podrás notar que la respuesta del token tiene un campo token_type, que está configurado en Bearer. Por lo tanto, debes colocar el Token de Acceso en el campo Authorization de los encabezados HTTP con el formato Bearer (Bearer YOUR_TOKEN).

Ahora puedes acceder a la API de Gestión de Logto solicitando el endpoint de la API de Gestión de Logto https://[your-tenant-id].logto.app/api, para obtener todas las aplicaciones en Logto

Recursos relacionados

Aquí hay algunos recursos relacionados que profundizan en nuestras ideas y estrategias previas para usar la API de Gestión de Logto. Estos materiales cubren varios aspectos, incluyendo mejores prácticas, consejos de implementación y casos de uso, para ayudarte a aprovechar al máximo la API de Gestión de Logto para tus proyectos.