Ferramenta API do Server
Use a ferramenta API do Server para interagir com a API do Server (v1, v2 e v3) sem a necessidade de gravar um fluxo de trabalho complexo. Para saber mais sobre acesso à API do Server, autenticação, pontos de extremidade, parâmetros e versões, vá para a página Visão geral da API do Server.
Dica
Esta ferramenta não é instalada automaticamente com o Alteryx Designer. Para usá-la, faça o download no Alteryx Marketplace.
A ferramenta API do Server é compatível com o Designer e com o Server versão 2021.4 e mais recente. Observe que determinados recursos da ferramenta podem ser limitados de acordo com a versão do Server.
Compatível com o Alteryx Multi-Threaded Processing (AMP) e o motor original.
Atualmente, a ferramenta API do Server não é compatível com o modo "Somente DCM" do Gerenciador de Conexões de Dados.
A ferramenta API do Server requer que você tenha estes pacotes instalados na sua máquina:
oauthlibrequests_oauthlib
Se você não tem esses pacotes instalados…
Adicione a ferramenta API do Server à tela do seu fluxo de trabalho e execute o fluxo de trabalho. A ferramenta gera um erro para alertar você sobre pacotes ausentes.
Navegue até à janela Resultados dos fluxos de trabalho e selecione a guia Tudo (ou a guia Arquivos para restringir a lista de itens).
Localize e selecione a mensagem que diz: "Execute este fluxo de trabalho vinculado como administrador para instalar os pacotes ausentes." Esse procedimento abre um novo fluxo de trabalho com uma ferramenta Python pré-configurada para instalar os pacotes necessários. Execute o fluxo de trabalho para fazer a instalação. Observe que você precisa executar esse fluxo de trabalho de instalação como administrador.
Outra opção é replicar a etapa acima e instalar os pacotes usando a ferramenta Python. Leia as informações em Instalação de pacotes adicionais para saber como instalar os pacotes.
A ferramenta API do Server tem seis âncoras:
Âncoras de entrada (ambas são opcionais):
Âncora de entrada A (Autorização): se você usar os valores dos campos na configuração da ferramenta, use esta âncora para fornecer as informações de autorização. Selecione o campo com o URL base da API e outro campo que contém as informações de autorização (que costuma ser o campo Autorização da saída A de uma ferramenta API do Server anterior). Observe que as informações de autorização são uma combinação do prefixo Bearer e do access_token que o oAuth2.0 gera quando você faz a autenticação inicial. Acesse Configuração e autorização da API do Server para obter mais informações.
Âncora de entrada D (Dados): se você usar os valores dos campos na configuração da ferramenta, use esta âncora para fornecer os parâmetros para seu ponto de extremidade. Observe que determinados pontos de extremidades têm parâmetros obrigatórios.
Âncoras de saída:
Âncora de saída A (authToken): essa âncora gera suas informações de autenticação para que fiquem prontamente disponíveis caso você queira fazer várias chamadas. Conecte essa âncora de saída à âncora de entrada A de outra ferramenta API do Server para reautenticar continuamente outra chamada de API em etapas posteriores.
Âncora de saída S (Sucesso): essa âncora gera as chamadas de API com o código de resposta 200. Analisamos as respostas da API um nível abaixo* e retornamos os campos aqui. Se não pudermos analisar uma resposta, o campo de saída Extraído mostrará uma mensagem com o motivo, e retornaremos os dados brutos nos campos de saída DownloadData e BinaryData.
Âncora de saída F (Falha): essa âncora gera as chamadas de API que não recebem o código de resposta 200.
Âncora de saída L (Logs): essa âncora gera as informações de log resultantes da sua chamada de API.
Esta é uma resposta simplificada para fins deste exemplo. O exemplo de JSON bruto exibe uma resposta JSON comum, seguida de um exemplo da mesma resposta gerada da ferramenta API do Server.
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
A mesma resposta foi formatada pela ferramenta API do Server conforme mostrado a seguir. Observe que o item de versões é consolidado em uma coluna/campo na resposta da ferramenta API do Server.
ID | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
Use a janela de configuração da ferramenta para configurar os campos necessários para executar a chamada de API.
Use a seção de autenticação para inserir as informações de autenticação necessárias. Para obter detalhes, acesse Chaves de API e acesso à API e Configuração e autorização da API do Server.
Usar valores de campos: desativada por padrão. Ative essa opção para especificar um campo de entrada que armazena as informações de URL base e token de autorização (Chave de acesso à API e Segredo de acesso à API). Selecione os campos nos menus suspensos Selecionar o campo de URL base e Selecionar o campo de autorização. Se você usar essa opção, nós usaremos apenas o primeiro registro que você fornecer como URL base e token de autenticação.
Você também pode inserir suas informações de autenticação diretamente na janela de configuração da ferramenta. Observe que esses campos estarão ocultos se você ativar a opção Usar valores de campos acima.
URL base: insira o URL base para a API do Server. Você pode configurar isso em Configuração da IU do Server.
Chave de API: insira a sua chave de API.
Segredo de API: insira o seu segredo da API.
Use a seção "Configuração da API" para selecionar seu método, escolher um ponto de extremidade e inserir os parâmetros para a chamada de API.
Escolher método: use esse menu suspenso para selecionar o método de API. Escolha entre…
GET: o método GET permite ler ou visualizar um recurso. Por exemplo, o método GET em um ponto de extremidade de usuários permite ler ou visualizar uma lista de usuários.
POST: o método POST permite criar um recurso. Por exemplo, o método POST em um ponto de extremidade de usuários permite criar um novo usuário.
PUT: o método PUT permite atualizar um recurso. Especificamente, o método PUT substitui o recurso atual. Por exemplo, o método PUT em um ponto de extremidade de usuários permite substituir os detalhes dos usuários existentes para atualizá-los pelas informações dos usuários que você inserir.
DELETE: o método DELETE permite excluir um recurso. Por exemplo, o método DELETE em um ponto de extremidade de usuários permite excluir um usuário existente. Quando você seleciona o método DELETE, aparece o botão de alternância Confirmar método DELETE. Você deve habilitar esse botão para concluir a exclusão.
Ponto de extremidade: use esse menu suspenso para selecionar o ponto de extremidade. As opções variam de acordo com o método que você seleciona. Para saber mais sobre pontos de extremidade e parâmetros da API do Server, vá para Pontos de extremidade e parâmetros da API, Acesso à API V3 do Server e Objetos da API V3 do Server.
Usar campos de entrada para parâmetros*: desativado por padrão. Ative esse botão para especificar os campos de entrada que serão usados como parâmetros. Na sequência, use os menus suspensos disponíveis para especificar o campo que contém as informações dos parâmetros.
Insira os valores dos parâmetros*: se você não utilizar campos de entrada para os parâmetros, poderá inserir os parâmetros diretamente nos campos fornecidos.
Parâmetros de ponto de extremidade
Observe que os parâmetros disponíveis dependem do ponto de extremidade. Além disso, alguns pontos de extremidade têm parâmetros obrigatórios, enquanto outros não. Para saber mais sobre pontos de extremidade e parâmetros da API do Server, vá para Pontos de extremidade e parâmetros da API, Acesso à API V3 do Server e Objetos da API V3 do Server.
Payload: se preferir, você pode inserir o payload manualmente aqui já no formato JSON. Você também pode usar o botão Usar campos de entrada para parâmetros acima para especificar o campo de entrada que contém o payload.
Exemplo de esquema: se aplicável, o exemplo de esquema é preenchido com uma estrutura correta para o payload da API. Você pode clicar no botão Usar o esquema no payload para copiar o texto genérico na guia de payload e modificá-lo.