🔌

REST API Integração com IA

Personalizado e API

Com o conector de API REST, seus assistentes consultam os sistemas internos e serviços personalizados que você configurar, com os endpoints, a autenticação, os cabeçalhos e os parâmetros que você definir. Peça os níveis de estoque mais recentes da API do seu depósito ou os pedidos de hoje da sua API de e-commerce.

Modo de Acesso
Leitura e Escrita
Tempo de Configuração
~10 minutos
Método de Autenticação
Chave de API
Disponível em breve Somente leitura por padrão

Conecte o REST API ao JoySuite

Seus assistentes chamam os endpoints REST que você configura quando alguém pergunta.

Disponível em breve. A configuração leva cerca de 10 minutos quando estiver pronto.
Entrar na Lista de Espera

O que você pode fazer

Tirar dados de um sistema interno normalmente exige pedir a um desenvolvedor ou aprender a API por conta própria.

Consulte um sistema interno

"Obtenha os últimos níveis de estoque da nossa API de armazém"

Faça uma pergunta e receba a resposta de um endpoint configurado, como a API do seu depósito.

Busque registros de um serviço

"Obtenha todos os pedidos da nossa API de e-commerce feitos hoje"

Peça os pedidos de hoje e receba-os da sua API de e-commerce.

Pesquise em um banco de dados próprio

"Encontre todas as contas criadas este mês"

Peça registros por data ou status do banco de dados por trás da sua API.

Verifique o status de um serviço

"Verifique o status do nosso gateway de pagamento"

Pergunte se um sistema como seu gateway de pagamento está respondendo.

Use vários endpoints de uma vez

"Consulte nossas APIs de catálogo de produtos e preços"

Faça uma pergunta que precisa de mais de uma API, como catálogo e preços.

Relacione dados internos a contas do CRM

"Quais dados internos se relacionam com contas no meu CRM?"

Veja quais registros dos seus sistemas se referem a contas do seu CRM.

O Que Seus Assistentes Podem Acessar

O JoySuite se conecta de forma segura ao REST API, disponibilizando esses recursos para seus assistentes de IA.

🌐

Endpoints de API

Configure e acesse múltiplos endpoints REST API com diferentes URLs base e caminhos.

URL Base Caminho Método Formato de Resposta Limites de Taxa
🔐

Autenticação

Suporte para múltiplos métodos de autenticação para proteger suas conexões.

Chaves de API Tokens Bearer OAuth 2.0 Autenticação Básica
📋

Headers

Configure headers personalizados para autorização, tipo de conteúdo e mais.

Authorization Content-Type Accept Headers Personalizados
🔍

Parâmetros de Query

Filtre e pesquise dados da API usando query strings e parâmetros.

Filtros Ordenação Paginação Termos de Busca Intervalos de Data
📦

Corpo da Requisição

Envie dados estruturados em requisições POST e PUT com JSON ou form data.

Payload JSON Form Data Upload de Arquivos Objetos Aninhados
🔄

Webhooks

Configure webhooks de entrada para receber atualizações de dados em tempo real.

Payload Tipo de Evento Timestamp Assinatura

Comandos do Conector

Use esses comandos especializados para interagir diretamente com seus dados do REST API nas conversas.

/api get

Buscar Dados

Recupere dados de qualquer endpoint GET configurado.

/api post

Enviar Dados

Envie dados para um endpoint POST e retorne a resposta.

/api search

Pesquisar Registros

Consulte endpoints de API com filtros e parâmetros de busca.

/api list

Listar Endpoints

Visualize todos os endpoints de API configurados e suas descrições.

/api schema

Ver Schema

Exiba a estrutura esperada de requisição e resposta.

/api test

Testar Conexão

Verifique conectividade da API e status de autenticação.

Os comandos respeitam suas permissões e configurações de acesso.

Conecte o REST API às Suas Outras Ferramentas

Veja como o REST API funciona com suas outras ferramentas conectadas.

🔧
+
☁️

Integração REST API + Salesforce

Coloque os dados dos seus sistemas ao lado das contas do Salesforce quando perguntar sobre um cliente.

🔧
+
💬

Integração REST API + Slack

Encontre dados dos seus sistemas ligados aos assuntos que sua equipe discute no Slack.

🔧
+
📊

Integração REST API + Tableau

Combine dados próprios com painéis do Tableau em uma só resposta.

🔧
+
⚡

Integração REST API + Zapier

Combine seus endpoints REST com os Zaps que você já tem no Zapier.

Permissões e Controle de Acesso

Você controla exatamente o que o JoySuite pode acessar dentro do REST API.

Padrão

Acesso de Leitura

Somente leitura é o padrão de todos os conectores. Os assistentes podem buscar e recuperar dados e não alteram nada no REST API, a menos que sua equipe de TI ative o acesso de escrita.

  • Buscar e consultar registros
  • Visualizar detalhes e histórico de registros
  • Acessar registros relacionados e associações
  • Visualizar relatórios e painéis
Requer aprovação de TI

Acesso de Escrita

O acesso de escrita fica desativado por padrão. Ele só está disponível quando sua equipe de TI o aprova e habilita explicitamente.

  • Criar novos registros
  • Atualizar registros existentes
  • Adicionar notas e atividades
  • Gerenciar associações
Para sua equipe de TI Segurança e confiança Como o JoySuite funciona com seu LMS

Perguntas frequentes

O JoySuite armazena dados da minha API?

Não. O JoySuite se conecta à sua REST API e consulta dados em tempo real. Seus dados ficam nos seus sistemas. O JoySuite só consulta esses dados quando você faz uma pergunta e não guarda nenhuma cópia.

Quais métodos de autenticação são suportados?

O JoySuite suporta chaves de API, tokens Bearer, OAuth 2.0 e autenticação básica. Você pode configurar o método de autenticação que corresponde à sua API.

O JoySuite pode escrever dados na minha API?

Sim. O JoySuite pode executar requisições POST, PUT e PATCH se sua API as suportar. Permissões de escrita são opcionais e configuráveis.

Quanto tempo leva a configuração?

Cerca de 10 minutos. Configure suas URLs de endpoint, autenticação e comece a fazer perguntas sobre seus dados.

Posso conectar múltiplas APIs?

Sim. Você pode configurar múltiplos endpoints de API com diferentes URLs base, métodos de autenticação e padrões de acesso.

Conectores Relacionados

Outros conectores usados com o REST API.

Zapier

Zapier

Personalizado e API
Salesforce

Salesforce

CRM e Vendas
Slack

Slack

Comunicacao
Google Workspace

Google Workspace

Comunicação

Conecte REST API assim que for lançado

Entre na lista de espera e avisaremos você quando o conector do REST API estiver disponível.

Entrar na Lista de Espera