Tipos de listas e configuração para uso em ações
Para facilitar o preenchimento de uma solicitação API, você pode criar uma lista, preenchê-la com os campos necessários e, quando configurar um campo na ação, vinculá-lo à lista desejada e criada anteriormente. Cada item da lista consiste em:
Chave única - um valor que será usado em todas as solicitações de API.
Nome - o texto que será exibido para o usuário quando um item da lista for selecionado no campo.
A lista pode ser estática ou dinâmica. No primeiro caso, todos os elementos são criados manualmente e nunca mudam. Ela é usada quando você precisa indicar o tipo da entidade criada com números (nota 1 - individual, 2 - entidade legal).
O segundo tipo faz uma solicitação de API no momento de criar uma conexão na Albato ou ao atualizá-la, estando saturado de elementos com base na resposta à solicitação. Portanto, a lista para cada usuário será única e terá seus próprios elementos. Esse tipo é aplicável quando você precisa indicar o status da entidade criada ou o ID do usuário responsável.
O número de listas pode ser ilimitado, pois uma lista pode usar um número ilimitado de campos. Ao criar a lista, você precisa especificar seu nome em diferentes idiomas e selecionar o tipo.
O nome de uma lista estática é interno. Para uma lista dinâmica, seu nome será exibido nas configurações de conexão do aplicativo.
Depois de criar uma lista, você não pode mais alterar seu tipo.
Consiste em um conjunto de campos, sendo que cada campo é um item da lista. Toda a personalização é feita adicionando campos e instruções de ID (chave única) e nome do item.
Neste exemplo, o elemento será exibido para o usuário como Pessoa física, e todas as solicitações de API usarão o valor individual quando este item da lista for selecionado.
Os itens também podem ser ordenados em uma guia separada após serem criados.
Este tipo já usa o widget de solicitação, que configura o comportamento da solicitação de saída da API por lista e analisa a resposta.
Depois de configurar a solicitação de saída (guia de requisição), você precisa configurar o analisador de resposta na guia de resposta.
Nesta guia, você deve especificar o caminho para a matriz de dados (mapeamento para a variável que contém a matriz de objetos com elementos) e mapear apenas dois campos: "Chave única" e "Nome do item".
Veja o exemplo para o seguinte formato de JSON:
Esse mapeamento é indicado como na imagem acima.
Além disso, no campo onde o nome do elemento é mapeado, você pode mapear várias chaves da resposta de uma vez. Assim, será possível exibir vários valores dinâmicos misturados com valores estáticos no nome do elemento.
Confira outro exemplo:
Nesse caso, se além do nome do status for necessário indicar o nome do funil ao qual pertence, o mapeamento é escrito da seguinte maneira:
Assim, o item da lista terá dois parâmetros dinâmicos em seu nome.
No momento, as listas dinâmicas são suportadas apenas na forma simples, ou seja, a resposta pode ser analisada a partir de apenas um array de objetos e os arrays dentro de arrays não são suportados.
Ao criar uma lista dinâmica, você também pode personalizar a guia de erros. Neste caso, os erros serão verificados no momento de criar/atualizar a conexão com a aplicação e haverá a indicação do texto do erro. Isso é aplicável quando você precisa lidar com um tipo específico de erro durante a autorização.
Depois de criar qualquer tipo de lista, você pode selecioná-la nas configurações dos campos de ação:
Tendo selecionado a lista ao lado deste campo, nas configurações da etapa de ação no próprio pacote, ela terá a seguinte aparência:
Será mais fácil para o usuário selecionar o elemento de que precisa e o valor correto irá para a solicitação da API. O mesmo acontece com uma lista dinâmica.
Chave única - um valor que será usado em todas as solicitações de API.
Nome - o texto que será exibido para o usuário quando um item da lista for selecionado no campo.
A lista pode ser estática ou dinâmica. No primeiro caso, todos os elementos são criados manualmente e nunca mudam. Ela é usada quando você precisa indicar o tipo da entidade criada com números (nota 1 - individual, 2 - entidade legal).
O segundo tipo faz uma solicitação de API no momento de criar uma conexão na Albato ou ao atualizá-la, estando saturado de elementos com base na resposta à solicitação. Portanto, a lista para cada usuário será única e terá seus próprios elementos. Esse tipo é aplicável quando você precisa indicar o status da entidade criada ou o ID do usuário responsável.
O número de listas pode ser ilimitado, pois uma lista pode usar um número ilimitado de campos. Ao criar a lista, você precisa especificar seu nome em diferentes idiomas e selecionar o tipo.
O nome de uma lista estática é interno. Para uma lista dinâmica, seu nome será exibido nas configurações de conexão do aplicativo.
Depois de criar uma lista, você não pode mais alterar seu tipo.
Lista estática
Consiste em um conjunto de campos, sendo que cada campo é um item da lista. Toda a personalização é feita adicionando campos e instruções de ID (chave única) e nome do item.
Neste exemplo, o elemento será exibido para o usuário como Pessoa física, e todas as solicitações de API usarão o valor individual quando este item da lista for selecionado.
Os itens também podem ser ordenados em uma guia separada após serem criados.
Lista dinâmica
Este tipo já usa o widget de solicitação, que configura o comportamento da solicitação de saída da API por lista e analisa a resposta.
Depois de configurar a solicitação de saída (guia de requisição), você precisa configurar o analisador de resposta na guia de resposta.
Nesta guia, você deve especificar o caminho para a matriz de dados (mapeamento para a variável que contém a matriz de objetos com elementos) e mapear apenas dois campos: "Chave única" e "Nome do item".
Veja o exemplo para o seguinte formato de JSON:
{"statuses": [ { "id": 12312, "name": "Aprovado", "active": true }]}Esse mapeamento é indicado como na imagem acima.
Além disso, no campo onde o nome do elemento é mapeado, você pode mapear várias chaves da resposta de uma vez. Assim, será possível exibir vários valores dinâmicos misturados com valores estáticos no nome do elemento.
Confira outro exemplo:
{"statuses": [ { "id": 12312, "name": "Aprovado", "pipelineName": "Status Aprovado" "active": true }]}Nesse caso, se além do nome do status for necessário indicar o nome do funil ao qual pertence, o mapeamento é escrito da seguinte maneira:
Funil - {{data.pipelineName}}, Status - {{data.name}}Assim, o item da lista terá dois parâmetros dinâmicos em seu nome.
No momento, as listas dinâmicas são suportadas apenas na forma simples, ou seja, a resposta pode ser analisada a partir de apenas um array de objetos e os arrays dentro de arrays não são suportados.
Informações adicionais
Ao criar uma lista dinâmica, você também pode personalizar a guia de erros. Neste caso, os erros serão verificados no momento de criar/atualizar a conexão com a aplicação e haverá a indicação do texto do erro. Isso é aplicável quando você precisa lidar com um tipo específico de erro durante a autorização.
Configuração para uso em ações
Depois de criar qualquer tipo de lista, você pode selecioná-la nas configurações dos campos de ação:
Tendo selecionado a lista ao lado deste campo, nas configurações da etapa de ação no próprio pacote, ela terá a seguinte aparência:
Será mais fácil para o usuário selecionar o elemento de que precisa e o valor correto irá para a solicitação da API. O mesmo acontece com uma lista dinâmica.
Atualizado em: 03/04/2023
Obrigado!