Chama o espaço de trabalho a partir do teu servidor

No Team e nos planos acima, a Klientr responde JSON em /api/v1. Envia Authorization Bearer e um token que começa por kl_. A resposta segue o papel desse colega.

O Starter deixa a API desligada. Team, Business e Studio incluem-na. Cria o token nas definições. É mostrado uma só vez.

Documentação Swagger da API REST

Cria um espaço de trabalho grátis Iniciar sessão

Nesta página

O mesmo trabalho que a app do agente já faz

Um token para a conta

Cada token pertence a um colega. As chamadas só leem ou alteram o que o papel permite, e só nos projetos que ele pode abrir.

Um projeto quando há vários

Envia X-Project-Id, ou project_id, quando o token pode ver mais do que um projeto. A chamada fica nesse projeto.

Caixa, marcações e o resto

Contactos, conversas, respostas, tarefas, marcações, serviços, artigos, o bot de FAQ, feedback, campanhas, menções sociais, colegas e definições do projeto.

Como funciona

Do token à primeira chamada

Cria um token

No Team ou acima, abre as definições e cria um token de API. Copia-o nessa altura. Não volta a ser mostrado.

Chama /api/v1

Envia JSON por HTTPS com Authorization Bearer e o token kl_. Acrescenta X-Project-Id quando o espaço tem mais do que um projeto.

Lê a referência

A página de documentação da API lista cada rota, com o pedido e a resposta. O rodapé do site também liga essa página.

Documentação Swagger da API REST

No espaço de trabalho

O que a API cobre

Tokens Bearer que começam por kl_
Contactos, conversas, mensagens, tarefas e marcações
Artigos, o bot de FAQ, feedback, campanhas e menções
Team, Business e Studio

Perguntas frequentes

Envia Authorization Bearer e um token que começa por kl_. Cria-o nas definições. O token é mostrado uma vez, e as chamadas seguintes usam esse mesmo valor.

Team, Business e Studio. O Starter não inclui tokens de API. Um token segue o papel do colega e os projetos que ele pode abrir.

Ao espaço de trabalho do agente, incluindo contactos, a caixa, tarefas, marcações, artigos, feedback, campanhas e menções sociais. Ligar um canal e pagar um plano fica no site.

O mesmo espaço de trabalho, a partir de outra pergunta.

Caixa partilhada Chat do site Formulário de mensagem Caixa de Telegram Caixa de WhatsApp Caixa de X Marcação de visitas Depósitos de reserva Google Calendar Voltar a reservar Avaliação após a visita Pacotes de visitas Menções sociais Menções no X Webhooks de saída Servidor MCP

Dá a cada cliente um único sítio onde chegar

Cria um espaço de trabalho grátis, liga um canal e mantém juntas a resposta, a marcação e o seguimento.