TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Lucas Vinicius Schiochet

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Lucas Vinicius Schiochet

Gravado em

Chave

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

...

 

O projeto importado possuí exemplo de dados e chamadas das APIs. Para entender a estrutura da API, nós podemos olhar a chamada Create User.

Lembre-se de definir o endpoint para o sandbox de desenvolvedores 

 

1) navegue para Users > Create User > Post e clique em Request 1

Na imagem abaixo:

1 é o nome da API e seu caminho relativo

2 é o método HTTP da API

3 é o link da janela de requisição, de um duplo-clique para abrir a janela de detalhes da API.

 

 

Na imagem abaixo:

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 and delete.

Image Modified 

 

Esta sessão irá utilizar 6 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. Obter o usuário atualizado
    5. Remover um usuário pelo id
    6. Obter o usuário removido, irá retornar uma mensagem de erro

 

Criar um novo Usuário

  1. Navegue 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 para Users > Create User > GET e clique em Request 1
    Image Modified
  2. Insira o valor do userId na área de parâmetros de url
    Image Modified
  3. Clique no botão send request, espere pelo resultado e verifique o mesmo.
    Image Modified

 

 

 

Atualizar usuário

Passo 1) navegue
  1. Navegue para Users > Update User > PUT e clique em Request 1

 

 

Passo 2) mude
  1. Image Added
  2. Mude o campo displayName para "jacob-update"
 
  1. Image Added

 

Passo 3)
  1. Clique no botão send request, espere pelo resultado e então verifique o mesmo.
 
  1. Image Added

 

Remover usuário pelo userId

Passo 1) navegue
  1. Navegue para Users > Update User > DELETE e clique em Request 1
 
  1. Image Added
Passo 2)
  1. Insira o userId
 
  1. Image Added

 

Passo 3)
  1. Clique no botão send request, espere pelo resultado e verifique o mesmo.
 
  1. Image Added

 

 

Obter um usuário removido retorna um erro

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

 

 

 

 

Image Added

 

top

APIs de Recursos

 

 

APIs de Recursos

Recursos são implementados para serem utilizados como opções de menu, mas podem ser extendidos 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
    • Obter o recurso menu1 pelo id, irá retornar uma mensagem de erro
    • Obter todos os recursos de aplicações, irá obter dois recursos: menu2, menu3
    • Remover todos os recursos de aplicações
    • Obter todos os recursos de aplicações, não irá obter nenhum recurso

 

Criar três recursos: menu1, menu2, menu3 para aplicação

Passo 1)
  1. Navegue para Resources > Create Resource > POST e clique em Request 1
 
  1. Image Added
Passo 2)
  1. Insira os dados dos recursos menu1, menu2, menu3 e o applicationId

 

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique o mesmo
.

  1. Image Added

 

 

Obter o recurso menu1 pelo id

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

 

 

 

Passo 2)
  1. Image Added
  2. Insira o id do menu1
 
  1. Image Added
Passo 3)
  1. Clique no botão send request, espere pelo resultado e verifique o mesmo.
 
  1. Image Added

 

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

Passo 1)
  1. Navegue para Resources > Get All Resources > GET e clique em Request 1
 
  1. Image Added

 

Passo 2)
  1. Insira o applicationId

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique o mesmo.
 
  1. Image Added

 

 

Remova o recurso menu1 pelo id

Passo 1)
  1. Navegue para Resources > Delete by Id > DELETE e clique em Request 1

 

 

 

Passo 2)
  1. Image Added
  2. Insira o id do recurso menu1

 

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique o mesmo.
    • Obter o recurso menu1 pelo id, irá retornar uma mensagem de erro
    • Obter todos os recursos de aplicações, irá obter dois recursos: menu2, menu3
    • Remover todos os recursos de aplicações
    • Obter todos os recursos de aplicações, não irá obter nenhum recurso

 

 

top 

APIs de Papéis

 

 

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

Este cenário de testes inclui os seguintes testes de caso:

    • Criar dois papéis: "user" e "admin" para a empresa
    • Obter o papel user pelo id
    • Obter todos os papéis da empresa, irá retornar dois papéis: "user", "admin"
    • Remover o papel "user" pelo id
    • Obter o papel "user" pelo id, irá retornar uma mensagem de erro
    • Obter todos os papéis da empresa, irá retornar um papel: "admin"
    • Remover todos os papéis de uma empresa
    • Obter todos os papéis da empresa, irá retornar um erro

Criar dois papéis: "user" e "admin" para a empresa

Passo 1)
  1. Navegue para Roles > Create Roles > POST e clique em Request 1

 

 

Passo 2)
  1. Image Added
  2. Insira o valor companyId e os dados para os papéis "user" e "admin"
 
  1. Image Added

 

Passo 3)
  1. Clique no botão send request, espere pelos resultados e verifique o retorno.
    • Obter o papel user pelo id
    • Obter todos os papéis da empresa, irá retornar dois papéis: "user", "admin"
    • Remover o papel "user" pelo id
    • Obter o papel "user" pelo id, irá retornar uma mensagem de erro
    • Obter todos os papéis da empresa, irá retornar um papel: "admin"
    • Remover todos os papéis de uma empresa
    • Obter todos os papéis da empresa, irá retornar um erro

 

top

APIs de Direitos

 

 

Direitos é 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"
  • Get all resources which entitled to user "Jacob", will get "menu1", "menu2"
  • Delete all entitled resources from user "Jacob"
  • Get all resources which entitled to user "Jacob", will get error

Create user "Jacob"

Passo 1)
  1. Navegue para Users > Create User > POST e clique em Request 1

 

 

Passo 2)
  1. Image Added
  2. Insira os dados do novo usuário, e clique no botão send

 

 

 

Passo 3)
  1. Image Added
  2. Aguarde os resultados e verifique os mesmos
.

 

 
  1. Image Added

 

Criar os recursos "menu1", "menu2" e "menu3"

Passo 1)
  1. Navegue para Resources > Create Resource > GET e clique em Request 1
 
  1. Image Added

 

Passo 2)
  1. Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere os resultados e verifique o mesmo.
 
  1. Image Added

 

 

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

Passo 1)
  1. Navegue para Entitlements > Assign Resources to User > POST e clique em Request 1

 

 

 

Passo 2)
  1. Image Added
  2. Insira o userId e o valor do id dos recursos "menu1" e "menu2"

 

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 
  1. Image Added

 

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

Passo 1)
  1. Navegue para Entitlements > Get Resources of User > GET e clique em Request 1

 

 

 

 

Passo 2)
  1. Image Added
  2. Insira o userId

 

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique o mesmo
 
  1. Image Added

 

 

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

Passo 1)
  1. Navegue para Entitlements > Unassign all Resources to User > DELETE e clique em Request 1

 

 

 

Passo 2)
  1. Image Added
  2. Insira o userId

 

 

 

Passo 1)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique se o mesmo não possui nenhum direito.

 

 
  1. Image Added

 

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

Passo 1)
  1. Navegue para Entitlements > Unassign all Resources to User > DELETE e clique em Request 1
 
  1. Image Added

 

Passo 2)
  1. Insira o userId

 

 

Passo 3)
  1. Image Added
  2. Clique no botão send request, espere pelo resultado e verifique o mesmo
 
  1. Image Added

 

top

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:


  • Criar o usuário "Jacob"
  • Criar os recursos "menu1", "menu2" e "menu3"
  • Atribuir os recursos "menu1" e "menu2" para o usuário "Jacob"
  • Adicionar o recurso "menu" como favorito do usuário "Jacob"
  • Obter os favoritos do usuário "Jacob" , irá retornar "menu2"
  • Remover os favoritos do usuário "Jacob"
  • Obter os favoritos do usuário "Jacob", irá retornar uma mensagem de erro

Passo 1) Navegue para Users > Create User > POST e clique em Request 1 (Criar usuário como na seção anterior)

 

 Image Added

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

Passo 1) Navegue para Favorites > Get user's Favorites > GET e clique em Request 1

 

 

 

Passo 2) Insira os dados do novo usuário, e clique no botão send

 

Passo 3) Espere o resultado e verifique o mesmo.

 

 

 

Crie os recursos "menu1", "menu2" e "menu3"

Passo 1) Navegue para Resources > Get All Resources of Application > GET e clique em Request 1

 

 

 

Passo 2) Insira os dados dos recursos menu1, menu2 e menu3 e preencha o applicationId

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

 

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

Passo 1) Navegue para Entitlements > Assign Resources to User > POST e clique em Request 1

 

 

 

Passo 2) Insira o userId e o id dos recursos "menu1" e "menu2"

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

 

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

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

 

 

 

Passo 2) Insira o userId e o id recurso "menu2" como favorito

 

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

 

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

Passo 1) Navegue para Favorites > Get user's Favorites > GET e clique em Request 1

 

 

 

Passo 2) Insira o userId

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

Remover os favoritos do usuário "Jacob"

Passo 1) Navegue para Favorites > Delete user's Favorites > DELETE e clique em Request 1

 

 

 

Passo 2) Insira o userId

 

 

Passo 3) Clique no botão send request, espere pelo resultado e verifique o mesmo

 

 

Remover os favoritos do usuário "Jacob"

 

Passo 1) Navegue para Favorites > Delete user's Favorites > DELETE e clique em Request 1

 

 

Passo 2) Insira o userId

 

 

 

Passo 3) Clique no botão send request, espere o resultado e verifique o mesmo. Nenhum dado de favoritos irá aparecer.

 

 

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