Ao usar o criador de integrações, você pode transferir parâmetros de solicitação dos tipos cadeia de caracteres, número, booliano e matriz no corpo da solicitação da API. Esta funcionalidade permite maior flexibilidade nas integrações da API e oferece suporte a uma maior variedade de casos de uso. Neste artigo, orientaremos você no processo de configuração desses parâmetros.
Este artigo contém os seguintes tópicos:
- Configuração do tipo de parâmetro nos parâmetros da solicitação
- Adição de reformatação para parâmetros de matriz
- Uso de parâmetros no corpo da solicitação da chamada da API
- Teste da configuração
Artigos relacionados:
Configuração do tipo de parâmetro nos parâmetros da solicitação
Como configurar o tipo de parâmetro nos parâmetros da solicitação
- Navegue para a seção Parâmetros da solicitação no criador de integrações.
- Defina seu parâmetro e o respectivo tipo como um dos seguintes:
- Cadeia de caracteres: para dados textuais entre aspas (por exemplo, "texto de exemplo").
- Número: para valores numéricos (por exemplo, 123).
- Booliano: para valores verdadeiro/falso.
-
Matriz: para uma coleção de valores (por exemplo, ["item1", "item2"]).
Adição de reformatação para parâmetros de matriz
Para fins de teste no criador de integrações com parâmetros do tipo matriz, você deve adicionar uma função de reformatação para garantir o tratamento adequado do tipo de dados. Para fazer isso, use a função a seguir:
$eval($)
Essa função analisa o valor da cadeia de caracteres em um objeto de matriz.
Se o parâmetro já for um objeto de matriz, a função não alterará seu comportamento.
Para obter mais informações, consulte Reformatação de valores em parâmetros de solicitação para agentes de IA.
Uso de parâmetros no corpo da solicitação da chamada da API
No corpo da solicitação da chamada da API, esses parâmetros podem ser usados no mesmo formato que os parâmetros de cadeia de caracteres, usando a sintaxe: {{<REQUEST_PARAMETER>}}
Embora o parâmetro possa aparecer visualmente como uma cadeia de caracteres no corpo — durante a execução ele se transformará no tipo de dados correspondente especificado na seção Parâmetros da solicitação.
Teste da configuração
Use o botão Testar produção no criador de integrações para executar sua chamada da API.
Verifique se os parâmetros estão sendo transmitidos com os tipos corretos (cadeia de caracteres, número, booliano, matriz) na solicitação.
Avalie a resposta para garantir o gerenciamento adequado pela API.