Parâmetros da solicitação
- Última atualização2024/10/31
Use a seção Parâmetros de solicitação para adicionar vários parâmetros, como caminho e consulta, às suas solicitações. Certifique-se de que esses parâmetros correspondam aos parâmetros usados no URL do terminal.
Ações
As seguintes ações de parâmetro da solicitação estão habilitadas:
- Adicionar
- Clicar em adicionar um parâmetro.
- Editar
- Passe o mouse sobre o ícone de três pontos do parâmetro que quer editar e clique no ícone de edição.
- Excluir
- Excluir os parâmetros selecionados.
Tabela de parâmetros
Visualize os seguintes detalhes do parâmetro na tabela.
| Item da tabela | Descrição |
|---|---|
| Tipo | Mostra se o parâmetro é de consulta ou de tipo. O tipo de parâmetro não é exibido para o usuário do pacote no Editor de bot ou no editor de Tarefa de API. |
| O valor é fornecido pelo usuário | Mostra se o valor é fornecido pelo usuário.
|
| Chave | Mostra o nome do da chave. 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. |
| Valor | Mostra o valor do parâmetro. O usuário do pacote poderá visualizar e atualizar esse valor no Editor de bot ou no editor de Tarefa de API. |
| Rótulo | Mostra o rótulo do parâmetro. O usuário do pacote poderá visualizar esse rótulo para o parâmetro no Editor de bot ou no editor de Tarefa de API. |
| Descrição | Mostra a descrição do parâmetro. O usuário do pacote poderá visualizar essa descrição do parâmetro no Editor de bot ou no editor de Tarefa de API. |
Adicionar parâmetros de solicitação
- Clique na guia Parâmetros de solicitação.
- Clique em Adicionar parâmetro ou no ícone de adição (+) na parte superior da tabela para adicionar um parâmetro.
- Na janela Adicionar parâmetro, selecione um dos seguintes tipos de parâmetro:
- 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}.
- No campo 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.
- Selecione uma das seguintes opções:
Codificado Insira um valor codificado para o parâmetro. O usuário do pacote não poderá 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 - Selecione se deseja que o tipo de valor de entrada seja protegido. Ao selecionar seguro, você poderá inserir o parâmetro por meio de uma credencial, variável ou string sem segurança.
- Selecione se esse campo é obrigatório.
- Insira um valor. O usuário do pacote poderá visualizar e atualizar esse valor no Editor de bot ou no editor de Tarefa de API.
- Insira um rótulo. O usuário do pacote poderá visualizar esse rótulo para o parâmetro no Editor de bot ou no editor de Tarefa de API.
- (Opcional) Insira uma descrição. O usuário do pacote poderá visualizar essa descrição do parâmetro no Editor de bot ou no editor de Tarefa de API. Ele aparecerá como texto de ajuda no editor.