Campos de dados remotos

O tipo de campo Dados remotos permite que quem edita trabalhe com dados de uma API HTTP externa. O Contismo consulta a API na edição e resolve o JSON ao vivo na entrega (repasse) ou permite escolher opções mapeadas que são salvas na entrada (seleção).

Use quando os valores devem vir de uma fonte externa ao vivo — catálogos de produtos, registros de um CRM, listas de locais ou qualquer API JSON — em vez de serem digitados manualmente.

Adicionar um campo de dados remotos

1. Abra Modelos de conteúdo ou Taxonomias no Studio.
2. Edite o modelo e adicione um campo.
3. Escolha Dados remotos como tipo de campo.
4. Configure a solicitação e a resposta (veja abaixo).
5. Clique em Testar conexão para verificar se a API responde como esperado.
6. Salve o modelo.

Configurar a solicitação

Cada campo de dados remotos precisa de uma configuração de solicitação:

• URL de dados remotos: a URL completa que devolve os dados deste campo.
• Método HTTP: GET ou POST.
• Parâmetros da solicitação (opcional): parâmetros da query string acrescentados à URL.
• Cabeçalhos da solicitação (opcional): cabeçalhos personalizados enviados com a solicitação. Marque um cabeçalho como É privado para armazená-lo como segredo criptografado.
• Autenticação básica (opcional): nome de usuário e senha para APIs que exigem autenticação básica HTTP.

Valores privados são criptografados

Cabeçalhos marcados como privados e senhas de autenticação básica são criptografados em repouso. Depois de salvar o campo, o valor secreto completo não é mostrado de novo. Guarde uma cópia em um lugar seguro se precisar reutilizá-lo em outro lugar.

Clique em Testar conexão ao desenhar o esquema para confirmar que a API responde. Um teste bem-sucedido mostra um resultado de exemplo e, quando aplicável, os caminhos de lista detectados na resposta.

Modos de resposta

Escolha como a resposta da API é usada no editor de entradas.

Repasse

Repasse resolve o valor do campo a partir da API remota quando o conteúdo é entregue, por exemplo ao ser consultado pela API GraphQL.

• Caminho da resposta (opcional): caminho em notação de pontos para extrair parte da resposta em vez de devolver a carga completa. Por exemplo, data.items ou 0.title quando a raiz é um array.

No editor de entradas, é possível abrir uma prévia da resposta atual da API com Ver dados.

Selecionar da lista

Selecionar da lista mapeia um array da resposta da API para opções de uma lista suspensa que podem ser escolhidas. O valor ou os valores selecionados são armazenados na entrada, no banco de dados.

Configure estes caminhos (notação de pontos relativa à raiz da resposta):

• Local da lista: caminho do array de itens (por exemplo, items ou data.results).
• Caminho do valor: propriedade de cada item a armazenar (por exemplo, id).
• Caminho do rótulo: propriedade de cada item a exibir (por exemplo, name).
• Tipo de seleção: Única ou Múltiplo.

No editor de entradas, as opções são buscadas automaticamente quando a entrada está aberta. Quem edita escolhe um ou mais valores da lista mapeada.

Relacionado

Para uma comparação rápida de todos os tipos de campo, consulte Tipos de campo.