TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 18

changes.mady.by.user Leoberto Jose Preuss Junior

Gravado em

comparado com

Nova versão 19

changes.mady.by.user Leoberto Jose Preuss Junior

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice

Índice
outlinetrue
excludeÍndice
stylenone

APIs para User Experience

 

Este tutorial explica como utilizar as APIs fluig Identity para as funcionalidades de User Experience baseadas em SCIM. APIs baseadas em SCIM são um subconjunto de APIs REST do fluig Identity, que estão documentadas neste artigo.

 

Localização das APIs: https://app.fluigidentity.com/rest/swagger-ui/index.html

 


 

Prepare o Ambiente

 

Este tutorial utiliza um cliente SOAP para acessar as APIs REST do fluig Identity. Este conjunto de instruções demonstra a configuração do cliente.

  1. Faça o download do aplicativo SoapUI em http://www.soapui.org/
  2. Abra o aplicativo SoapUI
  3. Faça o download do projeto teste CloudPass-Rest-soapui-project.xml
  4. Importe o projeto teste CloudPass-Rest-soapui-project.xml

    Image Modified

  5. Clique em File > Import Project

    Image Modified
  6. Selecione o arquivo CloudPass-Rest-soapui-project.xml
    Image Modified

...


Cliente SOAP para Windows

...


O projeto importado possui exemplos de dados e chamadas das APIs. Para entender a estrutura da API, podemos observar a

...

chamada Create User.

Lembre-se de definir

...

o endpoint para o sandbox de desenvolvedores.

Navegue

...

para Users > Create User > Post e clique

...

em Request 1 conforme a imagem abaixo:

Image Modified

1. É o nome da API e seu caminho relativo

2. É o método HTTP da API

3. É o link da janela de requisição. Dê um duplo clique para abrir a janela de detalhes da API.

...


Na imagem abaixo:

 Image Modified

1. Contém a área para parâmetros de URL

2. Contém a área do corpo da requisição HTTP

3. Contém o

...

botão send request

...

 



APIs de Usuário

 


As APIs de Usuário possuem 4 funções:

...

 Create, Get, Update e Delete.

Image Modified 

Esta sessão irá utilizar 5 passos para demonstrar essas funções.

  1. Criar um novo usuário
  2. Obter os dados de um usuário pelo id
  3. Atualizar usuário
  4. Remover um usuário pelo id
  5. Ao tentar obter o usuário removido, a chamada retorna um erro
Criar um novo Usuário
  1. Navegue

...

  1. para Users > Create User > POST e clique em Request 1
    Image Modified
  2. Insira os dados do novo usuário, e clique no botão Send
    Image Modified
  3. Verifique o retorno clicando na aba JSON
    Image Modified
Obter dados do usuário pelo id
  1. Navegue

...

  1. para Users > Get User by Id

...

  1. > GET e clique em Request 1
    Image Modified
  2. Insira o valor

...

  1. do userId na área de parâmetros de URL
    Image Modified
  2. Clique no

...

  1. botão send request, aguarde o resultado e verifique o mesmo.
    Image Modified
Atualizar usuário
  1. Navegue

...

  1. para Users > Update User > PUT e clique em Request 1
    Image Modified
  2. Mude o

...

  1. campo displayName para "jacob-update"
    Image Modified
  2. Clique no

...

  1. botão send request, aguarde o resultado e então verifique o mesmo.
    Image Modified
Remover usuário

...

pelo userId
  1. Navegue

...

  1. para Users > Delete User > DELETE e clique em Request 1
    Image Modified
  2. Insira

...

  1. o userId
    Image Modified
  2. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo.
    Image Modified

 


Ao tentar obter um usuário removido, a chamada retorna um erro

Use a chamada GET para o ID do usuário que acabou de ser removido (veja acima)

Image Modified

 


APIs de Recursos

...


Recursos são implementados para serem utilizados como opções de menu, mas podem ser estendidos para outras aplicações.

Nesta seção nós iremos aprender como criar, listar e deletar um recurso.

Este cenário de teste segue os seguintes casos de teste.

  • Criar três recursos: menu1, menu2, menu3 para aplicação
  • Obter o recurso menu1 pelo id
  • Obter todos os recursos de aplicações, irá obter três recursos: menu1, menu2, menu3
  • Remover o recurso menu1 pelo id
Criar três recursos: menu1, menu2, menu3 para aplicação
  1. Navegue

...

  1. para Resources > Create Resource > POST e clique em Request 1
    Image Modified
  2. Insira os dados dos recursos menu1, menu2, menu3 e

...

  1. o applicationId

    Image Modified
  2. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo

    Image Modified

 


Obter o recurso menu1 pelo id
  1. Navegue

...

  1. para Resources > Get Resource > GET e clique em Request 1

    Image Modified

  2. Insira o id do menu1

    Image Modified

  3. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo.

    Image Modified

...


Obter todos os recursos de aplicações, irá obter três recursos: menu1, menu2, menu3
  1. Navegue

...

  1. para Resources > Get All Resources > GET e clique em Request 1

    Image Modified

  2. Insira

...

  1. o applicationId

    Image Modified

  2. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo.

    Image Modified

 


Remova o recurso menu1 pelo id
  1. Navegue

...

  1. para Resources > Delete by Id > DELETE e clique em Request 1
    Image Modified
  2. Insira o id do recurso menu1
    Image Modified

  3. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo.

...


APIs de Papéis

...


Papéis são conexões entre usuários e direitos.

Este cenário de testes inclui o seguinte teste de caso:

  • Criar dois papéis: "user" e "admin" para a empresa
Criar dois papéis: "user" e "admin" para a empresa
  1. Navegue

...

  1. para Roles > Create Roles > POST e clique em Request 1

    Image Modified

  2. Insira o

...

  1. valor companyId e os dados para os papéis "user" e "admin"

    Image Modified

  2. Clique no

...

  1. botão send request, espere pelos resultados e verifique o retorno.

 



 

APIs de Direitos

...


Direitos são como os recursos são atribuídos aos usuários.

Este cenário de testes contém os seguintes casos de teste:

  • Criar o usuário "Jacob"
  • Criar os recursos "menu1", "menu2", "menu3"
  • Atribuir os recursos "menu1", "menu2" para o usuário "Jacob"
  • Deletar todos os recursos com direitos do usuário "Jacob"
  • Obter todos os recursos que possuam direitos para o usuários "Jacob", irá retornar erro
Criar o usuário "Jacob"
  1. Navegue

...

  1. para Users > Create User > POST e clique em Request 1
    Image Modified
  2. Insira os dados do novo usuário, e clique no

...

  1. botão send
    Image Modified
  2. Aguarde os resultados e verifique os mesmos
    Image Modified

 


Criar os recursos "menu1", "menu2" e "menu3"
  1. Navegue

...

  1. para Resources > Create Resource > GET e clique em Request 1
    Image Modified
  2. Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId
    Image Modified
  3. Clique no

...

  1. botão send request, espere os resultados e verifique o mesmo.
    Image Modified

...


Atribuir os recursos "menu1" e "menu2" para o usuário "Jacob"
  1. Navegue

...

  1. para Entitlements > Assign Resources to

...

  1. User > POST e clique em Request 1
    Image Modified
  2. Insira

...

  1. o userId e o valor do id dos recursos "menu1" e "menu2"
    Image Modified
  2. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo

    Image Modified

 


Deletar todos os recursos com direitos do usuário "Jacob"
  1. Navegue

...

  1. para Entitlements > Unassign all Resources to

...

  1. User > DELETE e clique em Request 1
    Image Modified
  2. Insira

...

  1. o userId
    Image Modified
  2. Clique no

...

  1. botão send request, espere pelo resultado e verifique se o mesmo não possui nenhum direito.
    Image Modified

...


Obter todos os recursos que possuam direitos para o usuário "Jacob", irá retornar um erro
  1. Navegue

...

  1. para Entitlements > Unassign all Resources to

...

  1. User > DELETE e clique em Request 1

    Image Modified

  2. Insira

...

  1. o userId
    Image Modified

  2. Clique no

...

  1. botão send request, espere pelo resultado e verifique o mesmo
    Image Modified



 

 

APIs de Favoritos

 


Marcações de favoritos adicionadas a recursos para o usuário.

Este cenário de teste incluí os seguintes casos de teste:

  • Adicionar o recurso "menu2" como favorito do usuário "Jacob"

  • Obter os favoritos do usuário "Jacob" , irá retornar "menu2"

  • Remover os favoritos do usuário "Jacob"

 


Adicione o recurso "menu2" como favorito do usuário "Jacob"

  1. Navegue
para 
  1. para Favorites > Add Favorites
 > Add Favorites to User > POST e clique em Request
  1. to User > POST e clique em Request 1

    Image Modified

  2. Insira
o userId e
  1. o userId e o id recurso "menu2" como favorito
    Image Modified

  2. Clique no
botão send
  1. botão send request, espere pelo resultado e verifique o mesmo
    Image Modified

Obter os favoritos do usuário "Jacob", irá retornar "menu2"

  1. Navegue
para Favorites > Get
  1. para Favorites > Get user's
Favorites > GET e clique em Request
  1. Favorites > GET e clique em Request 1
    Image Modified
  2. Insira
o userId
  1. o userId
    Image Modified
  2. Clique no
botão send
  1. botão send request, espere pelo resultado e verifique o mesmo


Remover os favoritos do usuário "Jacob"

  1. Navegue
para Favorites > Delete
  1. para Favorites > Delete user's
Favorites > DELETE e clique em Request
  1. Favorites > DELETE e clique em Request 1
    Image Modified
  2. Insira
o userId
  1. o userId
    Image Modified
  2. Clique no
botão send
  1. botão send request, espere o resultado e verifique o mesmo. Nenhum dado de favoritos irá aparecer.

Image Modified