Início Rápido-v1

Aqui você vai ter de modo prático a forma de como consumir uma API de consulta dentro desta ferramenta de documentação.

Antes de mais nada, é importante você ler a seção "Introdução ao uso de API".

Vamos lá!

Consulta de processos que o usuário pode abrir

Para realizar consulta, abra uma nova guia do navegador para executar o passo a passo descrito abaixo.

1. Na nova guia do navegador, abra a documentação referente a rota: Listagem de processos permitidos para abertura de atividade por usuário;

2. Obter o identificador do ambiente (X-Server):

Após obter o X-Server, na guia aberta para consumo da rota de listagem de processos, vá até o parâmetro "X-Server", no bloco "Headers" e realize o preenchimento.

3. Obter a chave de segurança (apikey);

Após obter a "apikey", na guia aberta para consumo da rota de listagem de processos, vá até a seção "Authentication" e no campo "Header" e realize o preenchimento.

4. Como essa rota não necessita de nenhum outro parâmetro obrigatório, utilize o botão "Try It!" para ser executada. Pronto!

Você pode visualizar o retorno na seção "RESPONSE".

Com esses passos, você já pode consumir qualquer outra rota de serviço. Você também pode observar que é gerado automaticamente um código de REQUEST na seção "CURL". Esta ferramenta permite gerar um código exemplo de REQUEST para várias linguagens, basta selecionar na seção "LANGUAGE".

Vamos praticar mais um pouco?

Consulta de usuários

Para realizar consulta, abra uma nova guia do navegador para executar o passo a passo descrito abaixo.

1. Na nova guia do navegador, abra a documentação referente a rota: Consulta de usuários;

2. Preencha os campos "X-Server" e "apikey" como no exemplo anterior;

3. Clique no botão "Try It!" para ser executada;

4. Vamos utilizar um parâmetro para restringir a consulta. Na seção "QUERY PARAMS", vá até o campo "name", preencha com valor adm e clique no botão "Try It!". Neste caso, serão filtrados os usuários que contenha "adm" como parte do seu nome;

5. Agora, limpe o campo "name", vá até o campo "isAdm" e preencha com true. Clique em "Try It!". Dessa forma, serão filtrados os usuários que estão configurados como "Administrador".