Endpoint Response Model Generator: da resposta de uma API a um modelo
Ligar um sistema externo costuma começar com uma resposta JSON e uma página em branco. Que campos se tornam colunas? O que fazer com listas aninhadas? O Endpoint Response Model Generator lê a resposta de um teste de endpoint e propõe as duas partes da solução: um modelo de dados para os registos e os mapeamentos de campos para um Workflow de sincronização. Aparece onde configura e testa endpoints de API, nas definições de integração.
O Worknano é personalizável com IA e focado nas funcionalidades essenciais. Os dados sincronizados ficam num modelo normal, com a mesma UI, UX e base de dados de tudo o resto, e não num armazenamento especial.
O que faz
- Lê o corpo da resposta de um endpoint testado, bem como o nome, o caminho, o método e o slug, quando os indica.
- Propõe um modelo simples. Os valores únicos úteis tornam-se colunas reais, sobretudo os que vai reportar ou filtrar.
- Recomenda a forma de sincronização. Uma resposta com um objeto sugere atualizar um registo existente. Uma lista, ou uma estrutura comum que envolve uma lista, sugere criar registos.
- Guarda listas ou objetos aninhados como texto JSON apenas quando não há uma opção melhor.
- Inicia o modelo com um id e termina-o com a data e hora da sincronização, e mapeia apenas os campos que gerou.
- Trata os campos personalizados que o fornecedor envia como entradas com nome, tipo e valor, quando o modelo de destino tem onde os guardar. A importação acrescenta então as definições ao registo pai e os valores a cada linha.
Quando ajuda
- Uma importação de CRM. Testa o endpoint que lista negócios noutra ferramenta. O agente propõe um modelo de negócios com montante, fase e data de fecho como colunas reais.
- Um único objeto de definições. Um endpoint devolve um objeto com os detalhes do seu plano. O agente sugere um modelo e uma regra de atualização, e não um registo novo de cada vez.
- Uma ferramenta de projetos com campos personalizados. Cada projeto na origem define os seus próprios campos. O agente mapeia-os para que os valores cheguem com as respetivas definições.
Como funciona com os seus dados
Este agente não tem ferramentas. Não chama o endpoint por si próprio e não escreve registos. O teste do endpoint já foi executado, e a resposta é-lhe transmitida. O agente devolve um rascunho de modelo e uma sugestão de mapeamento, e você revê ambos antes de qualquer coisa ser guardada. Aplicar um modelo é uma alteração de configuração, por isso fica com as pessoas que podem editar a configuração. As credenciais e os segredos de ligação nunca fazem parte do que o agente vê.
Usa um modelo rápido. A entrada é um corpo de resposta e a saída é estruturada, por isso a velocidade importa mais do que a profundidade.
O que não faz
- Não testa nem chama o endpoint. Isso faz primeiro, e uma resposta sem campos úteis dá uma proposta pouco útil.
- Não adivinha significados que a resposta não mostra. Verifique nomes e tipos, sobretudo para datas e valores monetários.
- Não executa a sincronização. Quem o faz é o Workflow, depois de aceitar o mapeamento.
Para um modelo escrito manualmente a partir de uma descrição, use o Model Designer. Para o próprio passo de sincronização, veja o Workflow Creator.
Personalize-o
Este agente é um registo no módulo Agents. Pode editar as instruções para as adaptar às suas regras de nomenclatura, alterar o modelo ou a temperatura, duplicá-lo para um fornecedor específico ou começar com um agente em branco.
Comece por Crie o seu próprio agente, leia Como editar um assistente de página e um agente reutilizável para os passos do editor, ou veja a visão geral em Agentes IA e Assistentes IA.