Versões comparadas

Chave

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

Criando uma Atividade de Http - Chamada de API.

Utilize esta Atividade para testar suas API´s.

Interface de Programação de Aplicação cuja sigla API provém do Inglês Application Programming Interface, é um conjunto de rotinas e padrões estabelecidos por um software para a utilização das suas funcionalidades por aplicativos que não pretendem envolver-se em detalhes da do software, mas apenas usar seus serviços. No RM são exemplos: Consulta, inserções, deleções e alterações em alguns de seus cadastros ou até mesmo extração de informações.

...

  1. Após estar devidamente configurados conforme os requisitos deste tipo de Atividade carregue o Host do RM como Administrador.
  2. Vamos utilizar como exemplo a inclusão de uma nova moeda.
  3. O primeiro item que precisamos é a informação da chamada para o método POST da API de inclusão de moedas.
  4. As APIS´s do Host podem ser consultadas pelo swagger inserindo a URL a seguir em seu navegador
  1. http://localhost:8051/api/swagger/ui/index#!/

...

  1. e se essa página carregar, seu Host está corretamente configurado para o uso.Image Added
  2. Vamos utilizar em nosso exemplo o cadastro de Moedas do RM.Image Added
  3. Na página do swagger procure pelo item Currency. Clique sobre ele para que seja expandido. Note que existem vários métodos disponíveis. Iremos utilizar o POST, método que fará a inclusão da moeda.Image Added
  4. Selecione o método POST para que ele seja expandido. Role a tela até chegar na área PARAMETERS no campo em branco de nome RECORD. Vá ao campo imediatamente a direita que tem o nome BODY e clique sobre o schema para que ele seja transferido para o campo RECORD.
  5. Preencha todos os campos do cadastro ou somente os obrigatórios conforme imagem abaixo e clique no botão TRY IT OUT. Image Added
  6. Se tudo correr bem você receberá a resposta abaixo da imagem a seguir. Image Added
  7. Para criar sua Atividade acesso o TestFlow → Atividades → Serviços → Http. Preencha os dados de identificação (nome, permissões de acesso, versão e descrição e comportamento ao ocorrer erro).
  8. Em requisições clique no sinal de (mais)Image Added
  9. Na tela Método - URL informe o Verbo, a URL (conseguida na tela do swagger no navegador), Timeout, o status esperado no teste e uma descrição para a chamada como na imagem a seguir.Image Added
  10. Os itens: Autorização, Headers, Body, Queries e Cookies só devem ser preenchidos se sua chamada exigir. No caso do nosso exemplo a única exigida é a Autorização na qual devem ser informados os dados do usuário para acesso ao RM. Image Added
  11. Na guia BODY, escolha o Media Type application/json cole o o json criado na página do swagger.
  12. Navegue até a aba TESTE A REQUISIÇÃO. Selecione um servidor para execução. Lembrando que neste servidor o Agent do TestFlow deve estar em execução como Administrador. Clique aqui para mais informações sobre o agent.
  13. Clique no botão play e aguarde o resultado. Devem ser mostrados os dados que foram incluídos. Este é sinal de que sua requisição está correta e pronta para ser inserida em um Projeto ou Agendamento.Image Added
  14. Salve seu registro
<add key="WebServiceCulture" value="Invariant" /> 
<add key="DefaultDB" value="CorporeRM" />
<add key="HTTPPORT" value="8051" />

Através do swagger você poderá inclusive gerar o json do body da chamada.

Assim como toda Atividade no TestFlow 30 o Http também deve em seu header estar associado a um ou mais grupos e ter pelo menos um como administrador.

  1. Logar o erro: O erro capturado na execução será apresentado no log do projeto e não impedirá a execução do restante do teste. O resultado final do seu teste será "Executado com erro".

  2. Gerar erro de execução: O erro capturado na execução será apresentado no log do projeto e o restante do teste não será executado. O resultado final do seu teste será "Executado com erro".

  3. Gerar alerta e continuar: O erro capturado na execução será apresentado no log do projeto, o restante do teste será executado normalmente. O resultado final do seu teste será "Executado com alertas".

Para incluir uma requisição clique no sinal mais (+) e preencha corretamente os parâmetros da sua chamada

  1. Verbo HTTP: Informe a operação (POST, GET, PUT, PATCH, DELETE, HEAD)

  2. Timeout (segundos): Informe o tempo de espera da requisição.

  3. Status e retorno http esperado: Escolha na lista o código de retorno que a chamada deverá retornar para que seu teste tenha sucesso.

AUTORIZAÇÃO : Esta informação geralmente é obrigatório no RM. Então escolha o tipo Base e informe o usuário mestre e a senha totvs.

Os campos HEADERS, BODY, QUERIES E COOKIES não são obrigatórios e devem ser preenchidos de acordo com a necessidade da API.

Sua requisição pode ser testada clicando no botão TESTE A REQUISIÇÃO sem que a mesma tenha de ser incluída em um projeto de teste. Você também testá-la utilizando o Gerenciador de Execuções.

...

  1. .