CRM e vendas
folk no seu produto e nos seus agentes de IA, por uma API
O toolkit do folk cobre grupos e seus campos personalizados, pessoas, empresas, negócios (e outros objetos de um grupo) e notas: listar, criar e atualizar. O cliente conecta com uma chave de API que o Connect guarda, e cada execução é registrada, para o seu produto ou agente de IA trabalhar o CRM sem uma integração própria.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/folk_create_person/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"firstName": "<firstName>"
}
}Como funciona
Do cliente conectado à primeira chamada no folk.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do folk. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o folk.
Sincronizar leads no CRM
Quando alguém se cadastra no seu SaaS, crie uma pessoa, vincule-a a uma empresa e coloque-a em um grupo para que apareça no funil.
Mover negócios no funil
Liste os negócios de um grupo e atualize o campo personalizado Status quando o seu produto detectar uma mudança, o que move o negócio no funil.
Notas escritas por um agente de IA
Um agente resume uma ligação ou um e-mail e adiciona o texto como nota em Markdown na pessoa, empresa ou negócio certo.
Tools
13 tools do folk
- Listar gruposGETLista os grupos do workspace com id e nome. Os grupos contêm pessoas, empresas e negócios. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Listar campos personalizados do grupoGETLista os campos personalizados de um grupo para pessoas, empresas ou um tipo de objeto, com nome, tipo e as opções dos campos de seleção. Em pessoa ou empresa, cada campo do tipo objectField é um tipo de objeto do grupo, como Deals, e seu nome é o objectType das tools de objeto.
- Listar pessoasGETLista as pessoas do workspace com id, nomes, e-mails, telefones, cargo, empresas, grupos e valores dos campos personalizados. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar pessoaPOSTCria uma pessoa, opcionalmente em grupos e vinculada a empresas. O folk mescla duplicatas em segundo plano, o que pode sobrescrever parte dos dados enviados. Uma pessoa sem grupo só aparece na busca do folk.
- Atualizar pessoaPATCHAtualiza uma pessoa, alterando apenas os campos enviados. Uma lista (groups, companies, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a pessoa dele, junto com os valores dos campos personalizados nesse grupo.
- Listar empresasGETLista as empresas do workspace com id, nome, setor, e-mails, telefones, URLs, grupos e valores dos campos personalizados. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar empresaPOSTCria uma empresa, opcionalmente em grupos. Os nomes são únicos no workspace: um nome existente devolve essa empresa em vez de criar outra. Uma empresa sem grupo só aparece na busca do folk.
- Atualizar empresaPATCHAtualiza uma empresa, alterando apenas os campos enviados. Uma lista (groups, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a empresa dele, junto com os valores dos campos personalizados nesse grupo. Um nome já usado por outra empresa falha.
- Listar objetosGETLista os negócios, ou os objetos de outro tipo, de um grupo, com id, nome, pessoas e empresas vinculadas e valores dos campos personalizados, como o Status do negócio. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink. Um objectType desconhecido responde 404 com os tipos de objeto do grupo.
- Criar objetoPOSTCria um negócio, ou um objeto de outro tipo, em um grupo. As pessoas e empresas vinculadas já precisam estar no grupo, ou o folk as ignora. Um nome de campo personalizado desconhecido faz a requisição inteira falhar com 422.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Perguntas sobre o toolkit do folk
Preciso implementar a API do folk?
Não. O Connect já traz 13 tools do folk descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do folk?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
