Saltar para o conteúdo principal
A API da Ciarem permite conectar a Ciarem aos seus próprios sistemas: sincronizar contatos, gerenciar suas propriedades de CRM e etapas do funil, e ler conversas de forma programática. Está disponível nos planos Growth e Scale, e durante o teste gratuito para você experimentar antes de pagar.
Você não precisa da API para usar a Ciarem. Tudo no produto funciona sem escrever código. Recorra à API quando quiser integrar a Ciarem com ferramentas que não conectamos nativamente.

​
1. Crie uma chave de API

Você precisa ser administrador, em um plano Growth ou Scale, ou no teste gratuito.
1

Abra Chaves de API

No painel, acesse Configurações e depois Chaves de API.
2

Clique em Criar chave

Dê à chave um nome que diga para qual integração ela serve.
3

Copie o segredo

O segredo começa com oak_ e é exibido apenas uma vez: copie-o imediatamente e guarde-o como uma senha. Se perdê-lo, revogue a chave e crie uma nova.

​
2. Faça sua primeira solicitação

Cada solicitação se autentica com a chave como token bearer:
Uma resposta bem-sucedida identifica a organização à qual a chave pertence:

​
3. Explore

  • Crie e atualize contatos, incluindo suas propriedades personalizadas: consulte a referência da API.
  • Leia conversas e mensagens. Cada mensagem informa quem falou: o campo sender é contact, agent, ai ou system.
  • Gerencie os metadados do CRM: propriedades personalizadas e etapas do funil, as mesmas que sua equipe usa no painel.
  • Receba webhooks: faça a Ciarem chamar o seu servidor quando um contato, uma conversa ou uma mensagem mudar, em vez de consultar a API repetidamente. Veja Webhooks.
Continue com Autenticação e Erros, limites e paginação.