Skip to main content

Como usar o Postman

Você pode usar o Postman para testar a API V3 do Server.

Pré-requisitos:

  • É necessário ter o Postman instalado. O Postman está disponível em https://www.postman.com/downloads/ . Instale e crie uma conta. Certifique-se de usar a versão de desktop do Postman, não a versão de navegador. Depois de confirmar seu endereço de e-mail, você pode ser redirecionado para a versão de navegador.

    Nota

    A versão Web do Postman não pode acessar as APIs da maioria dos clientes porque essas APIs estão atrás do firewall. Portanto, a versão Web do Postman não consegue acesso.

  • Para testar a API do Server no Postman, é necessário ter uma chave e um segredo de API. Acesse a página de ajuda Funções de usuário e permissões para obter mais informações.

Adicionar a API ao Postman

Para testar a API do Server, importe-a para o Postman.

Obter URLs de documentação e token

  1. Para obter o seu URL de documentação, vá para a IU do Server, clique no ícone de ponto de interrogação no canto superior direito e selecione Documentação da API . Isso leva você para a página da API V3 do Swagger.

    api_postman_getdetails0.png
  2. Obtenha o URL de documentação . Observe a barra invertida dupla após "webapi".

    Nota

    Localhost só funcionará se o Server estiver sendo executado no mesmo host que o Postman. Caso contrário (se for uma estação de trabalho remota), utilize o hostname ou o endereço IP.

    api_address_docu.png

    Exemplo: http://localhost/webapi//swagger/docs/3 .

  3. Visualize qualquer ponto de extremidade de API.

  4. Clique no ponto de exclamação vermelho à direita para iniciar o processo de autenticação.

  5. Copie o URL do token. Exemplo: http://localhost/webapi/oauth2/token .

    api_copy_tokenURL.png

Carregar a documentação do Swagger no Postman

  1. No Postman, vá para a guia Collections .

  2. Clique em Importar .

  3. Insira o URL de documentação encontrado conforme descrito em Obter URLs de documentação e token .

  4. Clique em Importar .

    api_swagger_load_01.png
    api_swagger_load_02.png

    Isso adiciona a API V3 do Alteryx Server na guia de coleções à esquerda.

Criar token de acesso OAuth2 para usar em chamadas de API

Para poder enviar suas solicitações, é necessário configurar a autorização e criar um token de acesso OAuth2 no Postman.

  1. Vá para Collections e selecione Alteryx Server API V3 .

  2. Clique na guia Authorization .

  3. Selecione OAuth 2.0 como o tipo em Type .

    api_postman_auth.png
  4. Role para baixo a página de autorização até a seção Configure New Token .

  5. Defina o nome do token, como NOME_DO_SEU_TOKEN .

    Nota

    Com "NOME_DO_SEU_TOKEN", não estamos querendo fornecer uma entrada. Você pode inserir qualquer nome que desejar para o token em  Token Name .

  6. Em Grant Type , selecione  Client Credentials .

  7. Em Access Token URL , insira o URL_DO_TOKEN_ENCONTRADO_ACIMA .

  8. Em Client ID , insira  SUA_CHAVE_DE_ACESSO_API .

  9. Em  Client Secret , insira  SEU_SEGREDO_DE_ACESSO_API .

  10. Em Client Authentication , selecione  Send as Basic Auth header .

  11. Selecione o botão Get New Access Token .

  12. Clique em Proceed .

  13. Selecione o botão  Use Token .

    api_postman_auth2.png

Recriar seu token de acesso caso ele expire

Depois de algum tempo, seu token original expira e você recebe o erro 401 (falha de autenticação ao acessar a API). Para recriar o token:

  1. Selecione Alteryx Server API V3  na guia  Collections .

  2. Selecione Manage Tokens no menu suspenso Available Tokens .

  3. Selecione o token expirado (ele estará riscado).

  4. Exclua o token expirado.

  5. Crie um novo token conforme descrito em Criar token de acesso OAuth2 para usar em chamadas de API .

Usar API no Postman

O exemplo abaixo demonstra um padrão de API comum para

No exemplo a seguir, usaremos a API para recuperar o ID de usuário da lista de usuários no Server. Em seguida, usaremos esse ID de usuário para obter as informações detalhadas do usuário. Na última etapa, atualizaremos o registro do usuário usando os dados do usuário.

Para simplificar, vamos mudar o nome do usuário neste exemplo. Na prática, seria melhor fazer isso usando a IU do Server.

api_postman_search1.png
api_postman_search2.png
api_postman_search3.png
  1. Navegue até GET v3/users .

  2. Desmarque todos os oito parâmetros de consulta em Query Params (para pesquisar a coleção de usuários, selecione um ou mais parâmetros e insira valores de pesquisa).

  3. Selecione a guia Auth .

  4. Defina o tipo em  Type como OAuth 2.0 .

  5. Selecione o token que você criou acima.

  6. Clique em Send .

  7. Visualize os resultados na parte inferior da tela.

  8. Copie um UserID para usar na próxima etapa.

Obtenha um UserID a partir do exemplo acima ou diretamente na IU do Server (copiando-o a partir do URL quando estiver visualizando o usuário).

api_postman_getdetails1.png
api_postman_getdetails2.png
api_postman_getdetails3.png
  1. Navegue até o ponto de extremidade GET v3/users/{id} .

  2. Insira o UserID como o valor do parâmetro id .

  3. Selecione seu token na guia Authorization , como na etapa anterior.

  4. Clique em Send .

  5. Copie todo o objeto JSON da seção Body na parte inferior da tela (incluindo os colchetes à esquerda e à direita) para usar na próxima etapa.

Obtenha informações detalhadas de um usuário (o objeto JSON) na etapa anterior para usar nesta etapa.

api_postman_updatedetails1.png
api_postman_updatedetails2.png
api_postman_updatedetails3.png
  1. Navegue até o ponto de extremidade PUT v3/users/{id} .

  2. Insira o UserID como o valor do parâmetro id .

  3. Na guia Auth , selecione o token como na etapa anterior.

  4. Selecione a guia Headers .

  5. Desmarque a caixa de seleção Content-type porque não queremos enviar dados de formulário, mas um objeto JSON.

  6. Selecione a guia Body .

  7. Selecione  raw .

  8. Clique em JSON .

  9. Cole o objeto JSON dos dados do usuário.

  10. Edite os dados que deseja alterar.

  11. Clique em Send .

  12. Observe o código de retorno "200 OK".