Use a guia Parâmetros de solicitação para adicionar vários parâmetros, como caminho e consulta, às suas solicitações. Certifique-se de que os parâmetros adicionados correspondam aos parâmetros usados no URL do endpoint.

Ações

As seguintes ações de parâmetro da solicitação estão habilitadas:

Adicionar
Para adicionar parâmetros à solicitação.
Clique no ícone Adicionar para adicionar um parâmetro. O número de parâmetros exibido no título da tabela Parâmetros é atualizado automaticamente.
Editar
Para editar os parâmetros existentes que estão disponíveis na solicitação.
Na tabela de parâmetros, passe o cursor sobre o ícone de reticências verticais do parâmetro apropriado e clique no ícone Editar para editar o Tipo de parâmetro, Chave, Valor ou Tipo de valor.
Habilitar/Desabilitar
Para ativar ou desativar os parâmetros que estão disponíveis na solicitação. Você pode desativar um parâmetro para os seguintes cenários:
  • Quando a solicitação da API usa valores padrão.
  • Ao introduzir um novo recurso em uma implementação controlada do pacote de conectores.
  • Ao testar e iterar novos recursos em um pacote de conectores.
  • Ao solucionar problemas de um pacote de conectores que contém parâmetros com erros.
Na tabela Parâmetros, passe o cursor sobre o ícone de reticências verticais do parâmetro que você deseja ativar ou desativar e, em seguida, clique na opção Ativar/Desativar. O status do parâmetro é atualizado conforme necessário na tabela Parâmetros. Os parâmetros desativados não estão incluídos no pacote de conectores publicados.
Copiar
Para replicar os parâmetros existentes que estão disponíveis na solicitação.
Na tabela Parâmetros, passe o cursor sobre o ícone de reticências verticais do parâmetro apropriado e clique no ícone Copiar para duplicar o parâmetro selecionado. Insira uma nova chave no modal Copiar. Todos os outros atributos do parâmetro original são copiados para o novo parâmetro. Depois de copiado, o novo parâmetro é ativado por padrão. Se necessário, use a opção Ativar/Desativar para desabilitar o parâmetro manualmente. O número de parâmetros no título da tabela Parâmetros é atualizado automaticamente quando um novo parâmetro é criado usando a opção Copiar.
Você pode alterar o Tipo de parâmetro, o Valor ou o Tipo de valor do parâmetro duplicado no modal Copiar.
Excluir
Para excluir os parâmetros que estão disponíveis na solicitação.
Faça uma das seguintes ações para excluir parâmetros:
  • clique na caixa de seleção Selecionar tudo no cabeçalho da tabela e, em seguida, clique no ícone Excluir disponível acima da tabela para excluir vários parâmetros.
  • Passe o cursor sobre o menu de reticências verticais de cada parâmetro e, em seguida, clique no ícone Excluir para excluir o parâmetro individualmente.

Tabela de parâmetros

O título da tabela Parâmetros exibe o número total de parâmetros de solicitação em uma ação. Este número inclui tanto os parâmetros habilitados quanto os desabilitados.

Visualize os seguintes detalhes do parâmetro na tabela.

Coluna Descrição
Tipo Exibe o tipo do parâmetro. O parâmetro pode ser um parâmetro de Consulta ou um parâmetro de Caminho. O usuário do pacote não pode visualizar o tipo de parâmetro no Editor de bot ou no editor de Tarefa de API.
Chave Exibe a chave do parâmetro. O usuário do pacote não pode visualizar a chave no Editor de bot ou no editor de Tarefa de API. A chave é enviada como parte do cabeçalho.
Valor Exibe o valor do parâmetro. O usuário do pacote pode visualizar e atualizar esse valor no Editor de bot ou no editor de Tarefa de API.
O valor é fornecido pelo usuário Exibe o status do valor.
  • Sim: Se o valor é fornecido pelo usuário. O usuário do pacote deve inserir um valor apropriado ao configurar o parâmetro no Editor de bot ou no editor de Tarefa de API.
  • Não: Se o valor está codificado. O usuário do pacote não pode visualizar esse valor no Editor de bot ou no editor de Tarefa de API. Este valor é enviado como parte do cabeçalho.
Status Exibe o status do parâmetro.
  • Habilitado: Se o parâmetro está habilitado.
  • Desabilitado: Se o parâmetro está desabilitado.
Rótulo Exibe o rótulo do parâmetro para valores Fornecidos pelo usuário. O usuário do pacote pode visualizar o rótulo do parâmetro no Editor de bot ou no editor de Tarefa de API.
Descrição Exibe a descrição do parâmetro. O usuário do pacote pode visualizar a descrição do parâmetro no Editor de bot ou no editor de Tarefa de API.

Adicionar parâmetros de solicitação

Siga estas etapas para adicionar um parâmetro de solicitação:

  1. clique na guia Parâmetros de solicitação no painel Configuração.
  2. Clique em Adicionar parâmetro ou no ícone de adição (+) na parte superior da tabela para adicionar um parâmetro.
  3. No modal Adicionar parâmetro, faça o seguinte.
    1. Tipo de parâmetro: Selecione uma das seguintes opções:
      • Consulta: Esses parâmetros são anexados ao caminho do URL após um caractere ?. Por exemplo, /accounts?user_account=company.
      • Caminho: Esses parâmetros são anexados diretamente ao caminho do URL. Por exemplo, /accounts/{user_account}.
    2. Chave: Insira um nome de chave apropriado. O nome da chave não é exibido para o usuário do pacote no Editor de bot ou no editor de Tarefa de API. Esse nome é enviado como parte do cabeçalho.
    3. Selecione uma das seguintes opções na seção O valor será:
      Tipo Descrição
      Codificado Insira um valor codificado para o parâmetro. O usuário do pacote não pode visualizar esse valor no Editor de bot ou no editor de Tarefa de API. Este valor é enviado como parte do cabeçalho.
      Fornecido pelo usuário
      1. Tipo de entrada de valor: Habilite esta caixa de seleção para proteger o tipo de entrada de valor. Ao habilitar a caixa de seleção, você pode inserir o parâmetro por meio de uma credencial, variável ou string insegura.
      2. Este campo é obrigatório?: Selecione Não ou Sim dependendo dos requisitos do parâmetro.
      3. Valor (opcional): Insira um valor. O usuário do pacote pode visualizar e atualizar esse valor no Editor de bot ou no editor de Tarefa de API.
      4. Rótulo: Insira um rótulo para o parâmetro. O usuário do pacote pode visualizar o rótulo do parâmetro no Editor de bot ou no editor de Tarefa de API.
      5. Descrição (opcional): Digite uma descrição para o parâmetro. O usuário do pacote pode visualizar a descrição do parâmetro no Editor de bot ou no editor de Tarefa de API. A descrição aparece como texto de ajuda no editor.
  4. Clique em Adicionar para adicionar o parâmetro à solicitação.

    O novo parâmetro é exibido na tabela de Parâmetros e a contagem de parâmetros no título da tabela é atualizada automaticamente.

Repita as etapas para adicionar mais parâmetros.