Seleção de API
- 1 Descrição
- 2 Abas e Campos
- 2.1 1 - Aparência:
- 2.2 2 - Dados:
- 2.3 3 - API:
- 2.4 4 - Validação:
- 2.5 5 - Regras:
- 2.6 6 - Eventos:
- 2.7 7 - Exemplo de Response:
Descrição
O componente Seleção de API permite que os usuários selecionem uma ou mais opções entre um conjunto de opções dinâmicas carregadas de uma API. Ele é ideal para:
Preencher campos com base em dados externos
Filtrar e refinar resultados
Criar interfaces complexas com dados dinâmicos
Abas e Campos
1 - Aparência:
Título: O título que será exibido acima do componente Seleção de API.
Descrição: Uma descrição mais detalhada do que o usuário deve escolher.
Tamanho (porcentagem): Define a largura do componente Seleção de API em porcentagem da largura total do formulário.
Aparece no DataGrid (booleano): Define se o componente será exibido em um DataGrid.
Aparece no Datalist (booleano): Define se o componente será exibido em um Datalist.
Multiselect (booleano): Define se o componente permite a seleção de múltiplas opções.
Modo Autocomplete (booleano): Habilita a funcionalidade de autocompletar as opções à medida que o usuário digita.
2 - Dados:
Grupo de Segurança: Permite selecionar um grupo de segurança predefinido que determina quais APIs podem ser acessadas pelo componente.
Header da Requisição: Permite definir headers customizados para a requisição da API.
URL: A URL da API que será utilizada para carregar as opções.
Dados para Requisição: Permite definir dados que serão enviados na requisição para a API.
Multiline (booleano): Habilita a criação de um "cadastro de linhas" com campos para chave e valor, permitindo a construção de objetos complexos para a requisição.
Propriedade Label: Define a propriedade do objeto JSON retornado pela API que será utilizada para a label da opção.
Propriedade Value: Define a propriedade do objeto JSON retornado pela API que será utilizada para o valor da opção.
Propriedade Helper: Define a propriedade do objeto JSON retornado pela API que será utilizada para informações adicionais que podem ser exibidas para o usuário, como uma descrição ou dica.
3 - API:
Nome da propriedade: O nome da propriedade que será usada para acessar o valor inserido na área de texto no código e que será enviado no json via web-hook.
Nome da propriedade customizada: Permite definir um nome customizado para a propriedade da área de texo.
4 - Validação:
Obrigatório (booleano): Define se a seleção de uma opção é obrigatória ou não.
Validação condicional: Permite definir regras de validação que dependem do valor de outros campos do formulário.
Mensagem de erro customizada: Permite personalizar a mensagem de erro que é exibida quando a validação falha.
Regras de Campos Condicionais:
As regras de campos condicionais permitem que você oculte ou desabilite o componente Arquivo com base no valor de outros campos do formulário.
Exemplo:
Se o usuário selecionar a opção "Sim" no campo "Você possui um currículo?", o componente Arquivo será exibido.
Se o usuário selecionar a opção "Não" no campo "Você possui um currículo?", o componente Arquivo será ocultado.
Para criar uma regra de campo condicional:
Clique na aba "Regras".
Clique no botão "Adicionar regra".
Selecione o campo do qual você deseja que a regra dependa.
Selecione o operador de comparação (igual a, diferente de, etc.).
Selecione o valor que o campo deve ter para que o componente seja exibido.
Clique no botão "Salvar".
5 - Regras:
Ocultar (booleano): Permite ocultar o componente Botão de Opção com base em regras de validação condicional.
Desabilitar (booleano): Permite desabilitar o componente Botão de Opção com base em regras de validação condicional.
Regras de Campos Condicionais:
As regras de campos condicionais permitem que você oculte ou desabilite o componente Arquivo com base no valor de outros campos do formulário.
Exemplo:
Se o usuário selecionar a opção "Sim" no campo "Você possui um currículo?", o componente Arquivo será exibido.
Se o usuário selecionar a opção "Não" no campo "Você possui um currículo?", o componente Arquivo será ocultado.
Para criar uma regra de campo condicional:
Clique na aba "Regras".
Clique no botão "Adicionar regra".
Selecione o campo do qual você deseja que a regra dependa.
Selecione o operador de comparação (igual a, diferente de, etc.).
Selecione o valor que o campo deve ter para que o componente seja exibido.
Clique no botão "Salvar".
6 - Eventos:
Utilize o exemplo de API utilitário que possuímos para entender o funcionamento clique aqui
Possui evento (sim ou não): Define se a área de texto dispara eventos quando o usuário interage com ela.
URL: Define a URL para a qual os dados da área de texto serão enviados quando um evento for disparado.
Dados para requisição: Define os dados que serão enviados junto com a requisição para a URL.
Trigger: Define o evento que dispara a ação.
7 - Exemplo de Response:
Importante: o retorno deve estar dentro do objeto “DATA”
Mobile Saúde - Mosia Omnichannel