Explorando todo o potencial da Logto Management API
Neste artigo, iremos ressaltar novamente a definição da Logto Management API, explicar como ela funciona e apresentar cenários típicos para aumentar a tua produtividade e desbloquear mais casos de uso.
Product & Design
Como um serviço de infraestrutura, esforçamo-nos para facilitar e acelerar o uso da nossa Logto Management API. Recentemente, atualizámos nossos guias e tutoriais. Neste artigo, iremos ressaltar novamente a definição da Logto Management API, explicar como ela funciona e apresentar cenários típicos para aumentar a tua produtividade e desbloquear mais casos de uso.
O que é a Logto Management API
A Logto Management API é um conjunto poderoso de APIs pré-construídas que dá aos desenvolvedores total controle para personalizar a sua implementação de acordo com as necessidades do produto e a pilha tecnológica.
Ela está listada na lista de recursos da API e não pode ser excluída ou modificada. Tudo o que podes fazer na Consola de Administração do Logto também pode ser feito com a Logto Management API.
O identificador segue o padrão https://[tenant-id].logto.app/api
Inclui todas as permissões por padrão. À medida que o Logto cresce, continuaremos a tornar as permissões mais granulares.
Com a Logto Management API, podes acessar os robustos serviços de backend do Logto, que são altamente escaláveis e podem ser utilizados em uma infinidade de cenários. Para saber mais sobre as APIs disponíveis, visita Referências da API do Logto.
Cenários típicos para usar a Management API
Os nossos desenvolvedores implementaram muitas funcionalidades adicionais usando a nossa Management API. Acreditamos que a nossa API é altamente escalável e pode apoiar uma ampla gama de necessidades. Aqui estão alguns exemplos de cenários que não são possíveis com a Consola de Administração do Logto, mas podem ser alcançados através da Management API.
Implementar perfil de utilizador com a tua UI personalizada
O Logto atualmente não oferece uma solução de UI pré-construída para perfis de utilizador. Reconhecemos que os perfis de utilizador estão intimamente ligados a atributos de negócios e produtos. Enquanto trabalhamos para determinar a melhor abordagem, sugerimos usar as nossas APIs para criares a tua própria solução. Por exemplo, podes utilizar a nossa API de interação, API de perfil e API de código de verificação para desenvolver uma solução personalizada que atenda às tuas necessidades. Preparámos uma página dedicada Perfil de Utilizador para tutoriais e guias.
Um exemplo interessante é que a funcionalidade de perfil de utilizador do Logto Cloud é construída usando a Logto Management API.
Implementar gestão de organizações com a tua UI personalizada
Se está a usar a funcionalidade de organização para construir a tua aplicação multi-tenant, pode precisar da Logto Management API para tarefas como convites de organização e gestão de membros.
Da mesma forma, a funcionalidade de convite e colaboração do Logto Cloud também é construída usando a Logto Management API.
Para ampliar esse caso, para o teu produto SaaS, onde tens tanto administradores quanto membros no tenant, a Logto Management API pode ajudar-te a criar um portal de administração personalizado, adaptado às necessidades do teu negócio. Confere isto para mais detalhes.
Pesquisa avançada de usuários
A Consola de Administração do Logto suporta funções básicas de pesquisa e filtragem. Se precisas de mais opções avançadas para adaptar o teu serviço de gestão de utilizadores às necessidades do teu negócio, podes usar a Logto Management API. Ela suporta opções avançadas de pesquisa, como:
- Pesquisa aproximada
- Correspondência exata
- Sensibilidade a maiúsculas e minúsculas
- Especificar campos
Confere nossos tutoriais e guias sobre Pesquisa Avançada de Utilizadores.
Utilizar os logs do Logto para construir os teus próprios serviços
O log de auditoria do Logto permite que monitorizes facilmente a atividade de utilizadores e eventos. Ele fornece uma base sólida para vários cenários de negócios de gestão de utilizadores e verificação de integridade.
Ao utilizar a Management API, podes acessar dados de logs de auditoria em tempo real. Isso permite que desenhes o teu próprio modelo de esquema e painel, usando os dados de logs obtidos do Logto.
Migrar e importar utilizadores para o Logto
Usar a Management API pode facilmente ajudar-te a importar dados de utilizadores, especialmente se quiseres fazer uma migração para o Logto.
Depois de preparar os dados dos utilizadores e configurar a hash de senha e o esquema de utilizadores, configura a conexão da Management API e chamaremos a API criar utilizador para importar os dados dos utilizadores. Para saber mais sobre a migração, consulta este documento.
Como acessar a Logto Management API
Criar uma aplicação M2M
Seleciona o tipo de aplicação M2M e começa o processo de criação. Após a criação, serás direcionado para um módulo onde podes atribuir uma função de máquina-a-máquina.
Depois de fornecer um nome e uma descrição, vais ver um módulo que te pede para atribuir uma função. Este módulo inclui todas as funções M2M, as funções indicadas por um ícone do Logto significam que essas funções incluem permissões da Logto Management API.
Atribuir funções M2M inclui permissões da Logto Management API para a tua aplicação M2M.
Por que usar comunicação máquina-a-máquina e atribuir funções máquina-a-máquina?
Por que o Logto permite comunicação M2M (Máquina-a-Máquina) para chamar a Logto Management API em vez de usar chaves de API?
O Logto lida com a gestão da identidade do cliente e segue rigorosamente padrões abertos como OAuth 2.0 e OpenID Connect. Os tokens M2M oferecem interações seguras de servidor para servidor com escopos específicos, proporcionando melhor segurança do que as chaves de API estáticas. Ao contrário das chaves de API, que não expiram e representam um risco maior se comprometidas, os tokens M2M têm tempos de expiração definidos, limitando a janela para uso indevido potencial.
No Logto, usamos controle de acesso baseado em função (RBAC) para proteger e gerir o acesso à Logto Management API. Este diagrama de entidade mostra como funciona.
A relação entre permissões, recursos da API, funções e aplicação máquina-a-máquina.
Recuperar um token de acesso
Noções básicas sobre pedido de token de acesso
A aplicação M2M faz um pedido POST para o endpoint de token para recuperar um token de acesso, adicionando os seguintes parâmetros usando o formato application/x-www-form-urlencoded no corpo da entidade da requisição HTTP:
- grant_type: deve ser definido como
client_credentials - resource: o indicador do recurso que queres acessar
- scope: O escopo do pedido de acesso
E também precisas incluir as tuas credenciais M2M para que o endpoint de token autentique a tua aplicação M2M. Isso é conseguido ao adicionar um cabeçalho Authorization usando autenticação básica, onde o nome de utilizador é o ID da Aplicação e a senha é o Segredo da Aplicação.
Podes encontrar o ID da Aplicação e o Segredo da Aplicação na página de detalhes da tua aplicação M2M:
Um exemplo de pedido de token de acesso da Logto Management API é:
Recuperar token de acesso para a Logto Management API
O Logto fornece um recurso “Logto Management API” incorporado. É um recurso de leitura apenas com permissão all para aceder à Logto Management API, podes vê-lo na tua lista de recursos da API.
O indicador da API de recurso segue o padrão de https://{YOUR_TENANT_ID}.logto.app/api, e este será o valor de recurso usado no corpo do pedido de token de acesso.
Antes de acessar a Logto Management API, certifica-te de que a tua aplicação M2M foi atribuída com funções M2M que incluem a permissão all deste recurso “Logto Management API” incorporado.
Agora, junta tudo e envia o pedido:
Resposta do token
Um corpo de resposta bem-sucedido seria como:
Acessar a Logto Management API usando o Token de Acessohttps://docs.logto.io/quick-starts/m2m/#access-resource-using-access-token
Podes notar que a resposta do token tem um campo token_type, que é fixado em Bearer. Portanto, deves colocar o Token de Acesso no campo Authorization dos cabeçalhos HTTP com o formato Bearer (Bearer YOUR_TOKEN).
Agora podes acessar a Logto Management API fazendo um pedido ao endpoint da Logto Management API https://[your-tenant-id].logto.app/api, para obter todas as aplicações no Logto
Recursos relacionados
Aqui estão alguns recursos relacionados que exploram nossos insights e estratégias anteriores para usar a Logto Management API. Estes materiais cobrem vários aspetos, incluindo melhores práticas, dicas de implementação e casos de uso, para te ajudar a tirar o máximo proveito da Logto Management API para os teus projetos.