Explorando todo o potencial da Logto Management API
Neste artigo, vamos reforçar a definição da Logto Management API, explicar como ela funciona e mostrar cenários típicos para aumentar sua produtividade e desbloquear mais casos de uso.
Product & Design
Como um serviço de infraestrutura, nos esforçamos para tornar o uso da Logto Management API mais fácil e rápido. Recentemente, atualizamos nossos guias e tutoriais. Neste artigo, vamos reforçar a definição da Logto Management API, explicar como ela funciona e mostrar cenários típicos para aumentar sua produtividade e desbloquear mais casos de uso.
O que é a Logto Management API
A Logto Management API é um poderoso conjunto de APIs pré-construídas que dá aos desenvolvedores controle total para personalizar sua implementação de acordo com suas necessidades do produto e stack tecnológica.
Ela está listada na lista de recursos da API e não pode ser excluída ou modificada. Tudo o que você pode fazer no Logto Admin Console também pode ser feito com a Logto Management API.
Seu identificador segue o padrão https://[tenant-id].logto.app/api
Ela inclui todas as permissões por padrão. À medida que a Logto cresce, continuaremos a tornar as permissões mais granulares.
Com a Logto Management API, você pode acessar os robustos serviços de backend da Logto, que são altamente escaláveis e podem ser utilizados em uma infinidade de cenários. Para conhecer as APIs disponíveis, consulte as Referências da Logto API.
Cenários típicos para usar a Management API
Nossos desenvolvedores implementaram muitas funcionalidades adicionais usando nossa Management API. Acreditamos que nossa API é altamente escalável e pode atender a uma ampla gama de suas necessidades. Aqui estão alguns exemplos de cenários que não são possíveis no Logto Admin Console, mas que podem ser alcançados por meio da Management API.
Implementar perfil de usuário com sua IU personalizada
Atualmente, a Logto não fornece uma solução de IU pré-construída para perfis de usuários. Reconhecemos que os perfis de usuários estão intimamente ligados aos atributos de negócios e produtos. Enquanto trabalhamos para determinar a melhor abordagem, sugerimos que você use nossas APIs para criar sua própria solução. Por exemplo, você pode utilizar 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 suas necessidades. Preparamos uma página dedicada Perfil de Usuário com tutoriais e guias.
Um exemplo interessante é que a funcionalidade de perfil de usuário do Logto Cloud foi construída usando a Logto Management API.
Implementar gerenciamento de organização com sua IU personalizada
Se você estiver usando o recurso de organização para construir seu aplicativo multi-inquilino, pode precisar da Logto Management API para tarefas como convites para a organização e gerenciamento de membros.
Da mesma forma, o recurso de convite e colaboração do Logto Cloud foi construído usando a Logto Management API também.
Para estender esse caso, para o seu produto SaaS, onde você tem tanto administradores quanto membros no inquilino, a Logto Management API pode ajudá-lo a criar um portal de administração personalizado ajustado às necessidades do seu negócio. Confira isto para mais detalhes.
Pesquisa avançada de usuários
O Logto Admin Console suporta funções básicas de pesquisa e filtragem. Se você precisar de mais opções avançadas para personalizar seu serviço de gerenciamento de usuários de acordo com suas necessidades de negócios, pode 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
- Especificação de campos
Confira nossos tutoriais e guias de Pesquisa Avançada de Usuários.
Utilize os logs da Logto para construir seus próprios serviços
O log de auditoria da Logto permite que você monitore facilmente a atividade e eventos de usuários. Ele fornece uma base sólida para vários cenários de negócios de gerenciamento de usuários e verificação de integridade.
Utilizando a Management API, você pode acessar dados de log de auditoria em tempo real. Isso permite que você projete seu próprio modelo de esquema e painel de controle usando os dados de log obtidos da Logto.
Migrar e importar usuários para a Logto
Usar a Management API pode ajudá-lo facilmente a importar dados de usuários, especialmente se você quiser fazer uma migração para a Logto.
Depois de preparar os dados dos usuários e configurar a hashing de senha e o esquema de usuários, configure a conexão da Management API e nós chamaremos a API de criação de usuário para importar os dados dos usuários. Para saber mais sobre a migração, confira este documento.
Como acessar a Logto Management API
Criar um app M2M
Selecione o tipo de app M2M e inicie o processo de criação. Depois de criado, você será direcionado para um módulo onde poderá atribuir um papel de máquina-para-máquina.
Depois de fornecer um nome e uma descrição, você verá um módulo que solicita que você atribua um papel. Este módulo inclui todos os papéis de M2M, papéis indicados por um ícone da Logto indicam que estes papéis incluem permissões da Logto Management API.
Atribuir papéis de M2M inclui permissões da Logto Management API para o seu app M2M.
Por que usar máquina-para-máquina e atribuir papéis de máquina-para-máquina?
Por que a Logto permite a comunicação M2M (Máquina-para-Máquina) para chamar a Logto Management API em vez de usar chaves de API?
A Logto lida com gerenciamento de identidade do cliente e segue estritamente padrões abertos como OAuth 2.0 e OpenID Connect. Tokens M2M oferecem interações seguras de servidor para servidor com escopos específicos, proporcionando melhor segurança do que chaves de API estáticas. Diferentemente das chaves de API, que não expiram e oferecem maior risco se comprometidas, os tokens M2M têm tempos de expiração definidos, limitando a janela para possível uso indevido.
Na Logto, usamos controle de acesso baseado em papéis (RBAC) para proteger e gerenciar o acesso à Logto Management API. Este diagrama de entidade mostra como funciona.
A relação entre permissões, recursos de API, papéis e aplicação máquina-para-máquina.
Buscar um token de acesso
Noções básicas sobre solicitação de token de acesso
O app M2M faz uma solicitação POST para o endpoint de token para buscar um token de acesso, adicionando os seguintes parâmetros, utilizando o formato application/x-www-form-urlencoded no corpo da entidade HTTP:
- grant_type: deve ser configurado como
client_credentials - resource: o indicador de recurso que você deseja acessar
- scope: o escopo da solicitação de acesso
E você também precisa incluir suas credenciais M2M para o endpoint de token autenticar seu app M2M. Isso é conseguido adicionando um cabeçalho Authorization usando autenticação básica, onde o nome de usuário é o ID do App e a senha é o App Secret.
Você pode encontrar o ID do App e o App Secret na página de detalhes de sua aplicação M2M:
Um exemplo de solicitação de token de acesso da Logto Management API é:
Buscar token de acesso para a Logto Management API
A Logto fornece um recurso “Logto Management API” integrado, um recurso somente leitura com a permissão all para acessar a Logto Management API, você pode vê-lo na lista de recursos da sua API.
O indicador do recurso API segue o padrão https://{YOUR_TENANT_ID}.logto.app/api, e este será o valor do recurso usado no corpo da solicitação do token de acesso.
Antes de acessar a Logto Management API, certifique-se de que seu app M2M foi atribuído com papéis M2M que incluem a permissão all deste recurso integrado “Logto Management API”.
Agora, componha tudo o que temos e envie a solicitação:
Resposta do token
Um corpo de resposta bem sucedido seria assim:
Acessar a Logto Management API usando Token de Acesso
Você pode notar que a resposta do token tem um campo token_type, que é fixado em Bearer. Assim, você deve colocar o Token de Acesso no campo Authorization dos cabeçalhos HTTP com o formato Bearer (Bearer YOUR_TOKEN).
Agora você pode acessar a Logto Management API fazendo uma solicitação para o endpoint da Logto Management API https://[your-tenant-id].logto.app/api, para obter todas as aplicações na Logto
Recursos relacionados
Aqui estão alguns recursos relacionados que abordam nossos insights e estratégias anteriores para usar a Logto Management API. Esses materiais cobrem vários aspectos, incluindo melhores práticas, dicas de implementação e casos de uso, para ajudá-lo a aproveitar ao máximo a Logto Management API para seus projetos.