Configurar autenticação de chave de API no Drupal

A Autenticação de Chave de API oferece uma maneira simples e eficaz de proteger as APIs do Drupal. Após gerar chaves de API para os usuários, essas chaves atuam como identificadores exclusivos que ajudam a gerenciar e proteger o acesso às suas APIs do Drupal. Para autenticação, o cliente deve enviar o nome de usuário do Drupal do usuário, juntamente com sua chave de API, no cabeçalho de autorização de cada solicitação. Autenticação de API do Drupal O módulo verifica essa combinação antes de conceder acesso. O módulo suporta Drupal 8, 9, 10 e 11.

Parque infantil

Planos de preços

Agendar uma Reunião

Usando o Composer
Usando Drush
Instalação manual

Baixe o módulo:

compositor requer 'drupal/rest_api_authentication'
Acessar Estender menu no seu console de administração do Drupal e pesquise por Autenticação de API REST e JSON usando a caixa de pesquisa.
Habilite o módulo marcando a caixa de seleção e clicando em Instale botão.
Você pode configurar o módulo em:

{BaseURL}/admin/config/pessoas/rest_api_authentication/configurações_de_autenticação

Instale o módulo:
```
drush e drupal/rest_api_authentication
```
Limpe o cache:

drush cr
Você pode configurar o módulo em:

{BaseURL}/admin/config/pessoas/rest_api_authentication/configurações_de_autenticação

Observação: A instalação manual é suportada apenas até o Drupal 7. Para o Drupal 8 e versões superiores, você deve usar o Composer para instalação e gerenciamento de projetos.

Acessar Estender menu no seu console de administração do Drupal e clique em Instalar novo módulo.
Instalar o Drupal Autenticação da API miniOrange módulo baixando o zip ou a partir da URL do pacote (tar/zip).
Clique em Ativar módulos recém-adicionados.
Habilite este módulo marcando a caixa de seleção e clicando em instalar botão.
Você pode configurar o módulo em:

{BaseURL}/admin/config/pessoas/rest_api_authentication/configurações_de_autenticação

Pré-requisitos:

Interface de usuário REST: Este módulo fornece uma interface amigável para configurar o módulo REST.
Habilite os seguintes módulos de serviços da Web a partir do Estender seção (/admin/modules) do seu site Drupal:

JSON: API
Interface de usuário REST
Serviços da Web RESTful
Serialização

Autenticação da API do Drupal instala os módulos

Habilitar API e atribuir métodos:

O primeiro passo é habilitar a API e atribuir os métodos e operações permitidos para ela. Isso pode ser feito usando o Interface de usuário REST módulo ou modificando diretamente a configuração do Drupal.
Clique no Ativar API botão.
Para habilitar a API usando o módulo REST UI, clique em configurar botão (como mostrado abaixo).

No nosso exemplo, precisamos habilitar o /entidade/usuário API. Para fazer isso, clique na opção Habilitar ao lado dela.

Recursos do usuário de autenticação da API do Drupal

Como nosso objetivo é criar um usuário no Drupal, selecione as seguintes configurações:

Método: POST
Formato: JSON
Provedor de autenticação: rest_api_autenticação

Isso permite que o módulo de autenticação da API miniOrange autentique a API. Clique no botão Salvar configuração botão para continuar.

Configurações de recursos de autenticação da API do Drupal

Etapas de configuração

Configurar método de autenticação por chave de API:

Nesta etapa, geraremos uma chave de API. Para isso, navegue até a Autenticação API guia do módulo (/admin/config/people/rest_api_authentication/auth_settings).

Debaixo Configuração básica, habilite o Ativar autenticação alternancia.
Introduzir o Nome da Aplicação e selecione Chave API do Método de autenticação seção.

Autenticação de API do Drupal selecione o método de autenticação de API

Autenticação básica
Autenticação de chave API

Usando a autenticação básica

Desloque-se até o Configuração da chave API seção na mesma aba.
Selecionar Autenticação básica digite no menu suspenso.
De acordo com o relatório Nome utilizador No campo de texto, digite o nome de usuário para o qual deseja gerar a chave de API e clique em Gerar botão.
Depois que a chave da API for gerada, clique em Salvar configuração botão na parte inferior da página.
Se você deseja gerar uma chave para todos os usuários, clique em Gerar chave para todos os usuários botão.

Autenticação da API do Drupal Insira o nome de usuário para criar a chave da API

Você configurou com sucesso o método de Autenticação Básica.

Observação: Use o cabeçalho exclusivo específico do aplicativo ao autenticar a API.

Método de autenticação da API do Drupal configurado com sucesso

Agora você pode visualizar a chave de API gerada no Chave API campo do seu perfil de usuário.

Se você deseja que os usuários finais também gerem suas chaves de API, o gerenciamento de chaves de API estará disponível para eles se você habilitar a permissão, conforme mostrado na imagem.

Permissão de chave de API de autenticação de API do Drupal

Conceder permissões de função para criar usuários

Se necessário, você pode permitir que funções do Drupal que não sejam de administrador criem usuários. Para isso, atribua a permissão "Administrar usuários" às funções desejadas na página de Permissões (/admin/people/permissions) do seu site Drupal.

Usando a chave de API

Desloque-se até o Configuração da chave API seção na mesma aba.
Selecionar Chave API digite no menu suspenso.
De acordo com o relatório Nome utilizador No campo de texto, digite o nome de usuário para o qual deseja gerar a chave de API e clique em Gerar botão.
Depois que a chave da API for gerada, clique em Salvar configuração botão na parte inferior da página.
Se você deseja gerar uma chave para todos os usuários, clique em Gerar chave para todos os usuários botão.

Você configurou com sucesso o método de autenticação de chave de API.

Observação: Use o cabeçalho exclusivo específico do aplicativo ao autenticar a API.

Agora você pode visualizar a chave de API gerada no Chave API campo do seu perfil de usuário.

Se você deseja que os usuários finais também gerem suas chaves de API, o gerenciamento de chaves de API estará disponível para eles se você habilitar a permissão, conforme mostrado na imagem.

Conceder permissões de função para criar usuários

Se necessário, você pode permitir que funções do Drupal que não sejam de administrador criem usuários. Para isso, atribua a permissão "Administrar usuários" às funções desejadas na página de Permissões (/admin/people/permissions) do seu site Drupal.

Exemplo

Para melhor compreensão, vejamos um exemplo de uso da autenticação baseada em chave de API com a API de criação de usuário no Drupal.

Observação: A API /entity/user no Drupal é usada para criar um novo usuário.

Para criar um usuário no Drupal, você precisa fazer uma requisição POST com o nome de usuário do Drupal e a chave de API emitida pelo módulo de autenticação da API REST do miniOrange. O nome de usuário e a chave de API devem estar codificados em formato Base64. Consulte o exemplo abaixo para fazer a chamada.


Formato de solicitação HTML - 



Pedido: 

PUBLICAR Cabeçalho /entity/user?_format=json: 

        MÉTODO DE AUTENTICAÇÃO: application_id Aceitar: application/json Tipo de conteúdo: application/json Autorização: Básica codificada em base64 (O valor deve ser codificado em Base64 no formato: nome de usuário:chave-da-api.)



Corpo: { "nome": { "valor": " " }, "mail": { "valor": " " }, "pass": { "valor": " " }, "status": { "value": "1" } } Formato da solicitação CURL - curl --location --request POST ' /entity/user?_format=json' \ --header 'AUTH-METHOD: application_id' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic base64encoded ' \ --data-raw '{ "name": [ { "value": "Username" } ], "mail": [ { "value": "email" } ], "pass": [ { "value": "Password" } ], "status": [ { "value": "1" } ] }'

Você também pode consultar a imagem de solicitação do Postman mostrada abaixo

Solicitação do Postman de autenticação da API do Drupal

Solicitação de corpo do Postman de autenticação da API do Drupal

Uma resposta bem-sucedida retornará os detalhes do usuário que você criou (veja a imagem abaixo).

Autenticação da API do Drupal Resposta do Postman criou nó

Exemplo

Para melhor compreensão, vejamos um exemplo de uso da autenticação baseada em chave de API com a API de criação de usuário no Drupal.

Observação: A API /entity/user no Drupal é usada para criar um novo usuário.

Para criar um usuário no Drupal, você precisa fazer uma requisição POST com o nome de usuário do Drupal e a chave de API emitida pelo módulo de autenticação da API REST do miniOrange. O nome de usuário e a chave de API devem estar codificados em formato Base64. Consulte o exemplo abaixo para fazer a chamada.


Formato de solicitação HTML - 



Pedido: 

PUBLICAR Cabeçalho /entity/user?_format=json: 

        MÉTODO DE AUTENTICAÇÃO: application_id Aceitar: application/json Tipo de conteúdo: application/json CHAVE DE API: base64_encoded (O valor deve ser codificado em Base64 no formato: nome de usuário:chave-da-api.)



Corpo: 


        { "nome": { "valor": " " }, "mail": { "valor": " " }, "pass": { "valor": " " }, "status": { "value": "1" } } Formato da solicitação CURL- 



curl --location --request POST ' /entity/user?_format=json' \ --header 'AUTH-METHOD: application_id' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'API-KEY: base64_encoded ' \ --data-raw '{ "name": [ { "value": "Username" } ], "mail": [ { "value": "email" } ], "pass": [ { "value": "Password" } ], "status": [ { "value": "1" } ] }'

Você também pode consultar a imagem de solicitação do Postman mostrada abaixo

Uma resposta bem-sucedida retornará os detalhes do usuário que você criou (veja a imagem abaixo).

Parabéns! Você configurou com sucesso o método de Autenticação de Chave de API usando o módulo de Autenticação de API do Drupal.

Caso a configuração não tenha sido bem-sucedida, entre em contato conosco em drupalsupport@xecurify.com. Inclua uma captura de tela da janela de erro e nós o ajudaremos a resolver o problema e o guiaremos pela configuração.

Obrigado pela sua resposta. Entraremos em contato em breve.

Algo deu errado. Envie sua consulta novamente.

Conteúdo

Configurar autenticação de chave de API no Drupal

Pré-requisitos:

Habilitar API e atribuir métodos:

Etapas de configuração

Configurar método de autenticação por chave de API:

Usando a autenticação básica

Conceder permissões de função para criar usuários

Usando a chave de API

Conceder permissões de função para criar usuários

Exemplo

Exemplo

Entraremos em contato com você o mais breve possível!