Segregando o acesso à APIs por papel no portal do desenvolvedor

Este artigo tem como objetivo mostrar como funciona a segregação de APIs por perfil de usuário no portal dos desenvolvedores ( API Browser ).

O primeiro passo é subir o swagger da API diretamente no portal, você pode descobrir como conferindo nosso artigo Inserir, Alterar e Excluir um Swagger no Portal do desenvolvedor.  Se a api estiver sendo exibida através da integração com o manager, todo o processo definido no presente artigo não será aplicado.

O segundo passo é criar papéis para os usuário, isso pode ser feito através do menu Pessoas > Permissões > Papéis;

Obs -> O menu pessoas está localizado no canto superior esquerdo, como mostra a imagem abaixo:

Após acessar o menu Papéis, será aberta uma tela semelhante à essa:

Essa tela contém uma breve descrição sobre a criação e utilização do papel do usuário. Basicamente, para criar um papel basta atribuir um nome, adicionar o papel e clicar em salvar a ordem. Veja o print abaixo:

Na imagem acima, podemos ver que atribuímos o nome do papel de artigo e em seguida, clicamos em adicionar papel e salvar ordem. O próximo passo é atribuir/alterar as permissões desse papel, para isso, iremos clicar em editar permissões. Veja a imagem abaixo:

Em seguida, será aberta uma tela com várias opções de permissões para serem atribuídas para o papel em questão. No exemplo abaixo, vamos dar apenas uma permissão ( Administer APIs heath )  para o papel em questão.

Obs -> Para atribuir essa permissão, basta apenas habilitar o checkbox e ir no fim da página e clicar em salvar permissões. Veja as imagens abaixo:

Feito isso, no momento de importar o swagger no portal, você irá encontrar a opção Papel ( Este é um campo obrigatório a ser marcado ), sendo que, você poderá selecionar um ou mais papéis. Veja a imagem abaixo:

Note na imagem, que o papel criado anteriormente (artigo) está presente dentre as opções. Caso selecionado, apenas os usuários que possuem esse papel poderão ter acesso a API no menu API Browser.

Obs -> É importante ressaltar que qualquer papel presente neste menu pode ser selecionado, independe de ser um papel que existe por padrão do Drupal ( usuário anonimo e usuário autenticado ) ou um papel criado manualmente ( como é o caso do papel artigo, que foi criado para o desenvolvimento dessa explanação).