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 go.postman.co/home .
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.
Primeiro, você precisa obter o link que será usado para importar a API V3 do Server. Para encontrar o link, vá para a IU do Server, selecione o ícone do 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.
Anote o endereço da documentação da API que você encontra na página Swagger.
No Postman, vá para Coleções e selecione Importar .
Selecione Link e insira a URL da API do Server que você anotou na etapa 2 e selecione Continuar .
Agora você pode ver a API V3 do Alteryx Server na guia Coleções .
Configurar autorização
Para poder enviar suas solicitações, é necessário configurar a autorização no Postman.
Vá para Collections e selecione Alteryx Server API V3 .
Na guia Autenticação , selecione o tipo OAuth 2.0 .
Configure o Token atual da seguinte maneira:
Na seção Configurar novo token , configure o seguinte:
Opcionalmente, digite um Nome de token .
Em Tipo de concessão , selecione Credenciais do cliente .
Em URL do token de acesso , insira o ponto de extremidade para o servidor de autenticação. Para encontrar o ponto de extremidade, vá para Swagger e procure o URL do token . Para obter mais informações, visite a seção Como autenticar na página de ajuda Configuração e autorização da API .
Exemplo da configuração final do token:
Em ID do cliente , digite a Chave de acesso à API localizada em "Meu perfil" na IU do Server.
Em Segredo do cliente , digite a Chave secreta da API localizada em "Meu perfil" na IU do Server.
Em Autenticação de cliente , selecione Enviar como cabeçalho de autenticação básica .
Selecione Obter novo token de acesso .
Configurar ambiente
Não se esqueça de configurar os mesmos valores em Ambiente .
Selecione o ícone de olho no canto superior direito e, em seguida, selecione Adicionar para "Ambiente".
Insira o nome do seu ambiente.
Insira o mesmo URL base, segredo e chave de API usados na etapa 4 da seção "Configurar autorização".
Insira o URL para o ambiente. Você pode encontrá-loem Configurações do sistema Alteryx como o Endereço de base . Consulte a etapa 4 da seção "Configurar autorização".
Clique em Salvar .
Enviar solicitações
Você pode testar a API do Server no Postman – autorizar e enviar suas solicitações ou explorar diferentes tipos de código de suas solicitações.
Exemplo
Digamos que você gostaria de recuperar uma lista de ativos que um usuário possui.
Primeiro, você precisa saber o ID de usuário específico.
Vá para Coleções e selecione API V3 do Alteryx Server .
Selecione Usuários e, em seguida, selecione OBTER Pesquisar registros de usuários .
Na guia Parâmetros , você pode usar os parâmetros para pesquisar em todos os registros de usuários.
Para enviar a solicitação, selecione Enviar e obtenha resultados com base nos parâmetros inseridos.
Nos resultados, copie o ID do usuário para o qual deseja recuperar a lista de ativos.
Em outra guia, abra outra solicitação. Vá para Usuários e selecione {id} .
Selecione OBTER Recuperar uma lista completa de ativos que um usuário possui . Insira o ID de usuário obtido através da solicitação anterior para obter a lista de ativos deste usuário.
Nota
Ao enviar uma solicitação via Postman, não se esqueça de autorizá-la. Para atualizar a solicitação, você tem duas opções:
Em Tipo , selecione OAuth2 e, em seguida, selecione um de seus tokens disponíveis.
Em Tipo , selecione Herdar autenticação do pai . A autorização configurada para toda a coleção será usada.