API

Outros sistemas podem utilizar a inteligência analítica do Gaio por meio de APIs. Essa funcionalidade permite conectar fluxos do Gaio a serviços externos via APIs RESTful, utilizando autenticação segura por chaves de API (API Keys).

---

How to Use

---

1. Acesse a Aba API

• No painel lateral esquerdo, clique no ícone API.

• Utilize a aba API Key para criar e gerenciar suas chaves.

• Utilize a aba API para configurar chamadas de API para serviços externos.

---

2. Criar uma Chave de API

1. Clique no botão "+" no canto superior direito da aba API Key.

2. Preencha os campos:

   • Name: Nome da chave (ex.: Doc).

   • Status: Selecione Ativo.

3. Clique em Generate.

4. Após a geração da chave, copie e salve em local seguro.

5. Para visualizar ou renovar a chave, utilize o ícone de olho ou o botão de renovação.

6. Clique em Save.

---

3. Configurar uma Integração de API

1. Na aba API, clique em "+" para adicionar uma nova integração.

2. Preencha os campos:

   • Name: Nome da integração (ex.: SendToCRM).

   • Endpoint: Apenas o nome final do endpoint (ex.: https://api.exemplo.com/send).

   • Select flow (opcional): Escolha o fluxo do Gaio que será executado.

   • Return table: Selecione a tabela que contém os dados a serem consumidos via API.

3. Vá até a aba API Key e marque a chave criada anteriormente.

4. Clique em Save.

---

4. Execução e Resultados

Após salvar a configuração:

• A API pode ser acionada manualmente ou como parte de um processo automatizado no Gaio.

• Caso um processo seja selecionado, sempre que o endpoint da API Gaio for chamado, esse processo será executado. Isso permite, por exemplo:

  • Criar/aplicar um modelo preditivo

  • Inserir ou excluir registros

  • Chamar APIs externas (REST)

  • Acessar fontes de dados externas ao Gaio

  • Utilizar qualquer outra funcionalidade do sistema

• Limite de Linhas: É possível limitar o número de linhas retornadas pela API do Gaio, mesmo que a tabela gerada possua milhões de registros.

https://your_url/endpoint?limit=10

• Utilize os parâmetros limit e offset para implementar paginação e navegar em grandes volumes de dados:

https://your_url/endpoint?limit=10&offset=10

• Também é possível usar limit e page para paginação baseada em número de página:

https://your_url/endpoint?limit=10&page=1

• Adicione parâmetros personalizados para filtrar e customizar as respostas da API com base em critérios específicos. Se a consulta anterior à tarefa de API filtrar a tabela usando esse parâmetro, apenas os dados solicitados serão retornados:

https://your_url/endpoint?limit=10&page=1&param_name_one=sales&param_name_two=male

Para cada API do Gaio, é gerada uma chave de acesso única.

---

Boas Práticas

• Segurança: Nunca compartilhe sua chave de API. Use o status Inativo para desativar temporariamente o acesso.

• Versionamento: Crie novas entradas para APIs que sofrerem mudanças estruturais.

• Validação: Teste os endpoints manualmente antes de integrá-los a fluxos automatizados.