Árvore de páginas

Versões comparadas

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

...

Identity para as funcionalidades de User Experience baseadas em SCIM. APIs baseadas em SCIM são um subconjunto de APIs REST do

...

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

...

Identity. Este conjunto de instruções demonstra a configuração do cliente.

Deck of Cards
historyfalse
idambiente
Card
defaulttrue
labelPasso 1

  • Faça o download do aplicativo SoapUI

...

  • Abra o aplicativo SoapUI.
  • Faça o download do projeto

...

  • teste CloudPass-Rest-soapui-project.xml.


Card
labelPasso 2


  • Importe o projeto

...

  • teste CloudPass-Rest-soapui-project.xml

Image Modified


Card
labelPasso 3


  • Clique em File

...

  • Import Project.

Image Modified

  • 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.

Deck of Cards
historyfalse
idcliente_soap
Card
defaulttrue
labelAbrir requisição


  • Navegue

...

  • para Users

...

  • Create User

...

  • Post e clique

...

  • em Request 1 conforme a imagem abaixo:

...

...

  1. É o nome da API e seu caminho relativo

...

  1. É o método HTTP da API

...

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

...

Image Added


Card
labelÁrea de requisição

...


  • Na imagem abaixo:

...

...

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

...

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

...

  1. Contém o

...

  1. botão Send request.

...

Image Added

 



APIs de Usuário

 

...

As APIs de Usuário possuem

...

quatro funções:

...

Create, Get, Update e Delete.

...

Image Removed 

Esta sessão irá utilizar

...

cinco passos para demonstrar essas funções.

  • Criar um novo usuário
  • Obter os dados de um usuário pelo

...

  • ID
  • Atualizar usuário
  • Remover um usuário pelo

...

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

Image Added


Criar um novo

...

usuário

Deck of Cards
historyfalse
idcreate_user
Card
defaulttrue
labelPasso 1

  • Navegue para Users → Create User → POST e clique em Request 1.

Image Added


Card
labelPasso 2

...


  • Insira os dados do novo usuário, e clique no botão Send.

Image Modified

Card
labelPasso 3


  • Verifique o retorno clicando na

...

  • aba JSON.

Image Modified


Obter dados do usuário pelo ID
Âncora
getuser
getuser

Deck of Cards
historyfalse
idget_user
Card
defaulttrue
labelPasso 1


  • Navegue

...

  • para Users

...

  • Get User by Id

...

  • GET

...

  • e clique

...

  • em Request 1.

Image Modified

Card
labelPasso 2


  • Insira o valor

...

  • do userId na área de parâmetros de URL.

Image Modified

Card
labelPasso 3


  • Clique no

...

  • botão Send request, aguarde o resultado e verifique o mesmo.

Image Modified


Atualizar usuário

Deck of Cards
historyfalse
idupdate_user
Card
defaulttrue
labelPasso 1


  • Navegue

...

  • para Users

...

  • Update User

...

  • PUT

...

  • e clique

...

  • em Request 1.

Image Modified

Card
labelPasso 2


  • Mude o

...

  • campo displayName

...

  • para "jacob-update".

Image Modified

Card
labelPasso 3


  • Clique no

...

  • botão Send request, aguarde o resultado e então verifique o mesmo.

Image Modified


Remover usuário pelo

...

userId

Deck of Cards
historyfalse
iddelete_user_by_id
Card
labelPasso 1


  • Navegue para Users → Delete User → DELETE e clique em Request 1.

Image Added

Card
labelPasso 2


  • Insira o userId.

Image Added

Card
labelPasso 3


  • Clique no botão Send request, aguarde o

...

  • resultado e verifique o mesmo.

Image Modified

...


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

...

erro

Use a

...

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

Image Modified

 


...

API 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

...

  • recursos

...

  • Obter o recurso menu1 pelo

...

  • ID
  • Obter todos os recursos de aplicações

...

  • Remover o recurso menu1 pelo

...

  • ID

Criar recursos

Irá criar três recursos: menu1, menu2

...

e menu3 para aplicação

Deck of Cards
historyfalse
idcreate_resource

...

Card
defaulttrue
labelPasso 1


  • Navegue para Resources → Create Resource → POST e clique em Request 1.

Image Added


Card
labelPasso 2

...


  • Insira os dados dos recursos menu1, menu2, menu3 e

...

  • o applicationId.

Image Modified

Card
labelPasso 3


  • Clique no

...

  • botão Send request,

...

  • aguarde o resultado e verifique o mesmo.

Image Modified

 



Obter o recurso menu1 pelo ID

Deck of Cards
historyfalse
idget_resource
Card
labelPasso 1


  • Navegue

...

  • para Resources

...

  • Get Resource

...

  • GET

...

  • e clique

...

  • em Request 1.

Image Modified


Card
labelPasso 2


  • Insira o

...

  • ID do menu1.

Image Modified


Card
labelPasso 3


  • Clique no 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.

Deck of Cards
historyfalse
idget_all_resources
Card
defaulttrue
labelPasso 1


  • Navegue

...

  • para Resources

...

  • Get All Resources

...

  • GET

...

  • e clique

...

  • em Request 1.

Image Modified

...


Card
labelPasso 2


  • Insira o applicationId.

Image Added


Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere pelo resultado e verifique o mesmo.

Image Modified

 


...

Remover o recurso menu1 pelo ID

Deck of Cards
historyfalse
id

...

delete_by_id
Card
labelPasso 1


  • Navegue para Resources → Delete by Id

...

  • DELETE

...

  • e clique

...

  • em Request 1.

Image Modified

Card
labelPasso 2


  • Insira o

...

  • ID do recurso menu1.

Image Modified


Card
labelPasso 3


  • Clique no

...

  • 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

Deck of Cards
historyfalse
idcreate_roles

...

Card
labelPasso 1


  • Navegue para Roles → Create Roles

...

  • POST

...

  • e clique em

...

  • Request 1.

Image Modified


Card
labelPasso 2


  • Insira o

...

  • valor companyId

...

  • e os dados para os papéis "user" e "admin".

Image Modified

Card
labelPasso 3


  • Clique no

...

  • 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"

...

Criar o usuário "Jacob"

Deck of Cards
historyfalse
idcreate_user_jacob
Card
defaulttrue
labelPasso 1


  • Navegue

...

  • para Users

...

  • Create User

...

  • POST

...

  • e clique em

...

  • Request 1.

Image Modified


Card
labelPasso 2


  • Insira os dados do novo usuário

...

  • e clique no

...

  • botão Send.

Image Modified


Card
labelPasso 3


  • Aguarde os resultados e verifique os mesmos.

Image Modified

...


Criar os recursos "menu1", "menu2"

...

, "menu3"

Deck of Cards
historyfalse
idcreate_resources_jacob
Card
label

...

Passo 1


  • Navegue para Resources → Get All Resources of Application → GET e clique em Request 1.

Image Added

Card
labelPasso 2

...


  • Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId.

Image Modified

Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere os resultados e verifique o mesmo.

Image Modified

...


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

Deck of Cards
historyfalse

...

idget_resources_of_user
Card
labelPasso 1


  • Navegue para Entitlements → Assign Resources to User

...

  • POST

...

  • e clique em

...

  • Request 1

...

  • .


Card
labelPasso 2

...


  • Insira

...

  • o userId

...

  • e o valor do

...

  • ID dos recursos "menu1" e "menu2".

Image Modified

Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere pelo resultado e verifique o mesmo.

Image Modified

...


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

Deck of Cards
idunassign_all_resources
Card
labelPasso 1


  • Navegue

...

  • para Entitlements

...

  • Unassign all Resources to User

...

  • DELETE

...

  • e clique em

...

  • Request 1

...

  • .


Card
labelPasso 2

...


  • Insira

...

  • o userId

...

  • .


Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere pelo resultado e verifique se o mesmo não possui nenhum direito.

...

 

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

...

 

...



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"

...

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

Deck of Cards
historyfalse
id

...

add_favorites_to_user
Card
labelPasso 1


  • Navegue para Favorites → Add Favorites to User

...

  • POST

...

  • e clique

...

  • em Request 1

...

  • .

Image Added



Card
labelPasso 2


  • Insira o userId e o ID do recurso "menu2" como favorito

...

  • .

Image Added

Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere pelo resultado e verifique o mesmo.

...

Image Added


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

Deck of Cards
historyfalse
idget_user_favorites
Card
labelPasso 1


  • Navegue

...

  • para Favorites

...

  • Get user's Favorites

...

  • GET

...

  • e clique

...

  • em Request 1

...

  • .

Image Added

Card
labelPasso 2


  • Insira

...

  • o userId

...

  • .


Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere pelo resultado e verifique o mesmo.



Remover os favoritos do usuário "Jacob"

Deck of Cards
historyfalse
iddelete_user_favorites
Card
labelPasso 1


  • Navegue

...

  • para Favorites

...

  • Delete user's Favorites

...

  • DELETE

...

  • e clique em

...

  • Request 1

...

  • .


Card
labelPasso 2


  • Insira

...

  • o userId

...

  • .


Card
labelPasso 3


  • Clique no

...

  • botão Send request, espere o resultado e verifique o mesmo. Nenhum dado de favoritos irá aparecer.

Image Removed

 




HTML
<!-- Hotjar Tracking Code for http://tdn.totvs.com/display/fb -->
<script>
    (function(h,o,t,j,a,r){
        h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
        h._hjSettings={hjid:1280165,hjsv:6};
        a=o.getElementsByTagName('head')[0];
        r=o.createElement('script');r.async=1;
        r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
        a.appendChild(r);
    })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>