Skip to content
xLumen

API

Papel do recurso

Section titled “Papel do recurso”

A API do xLumen permite integrar sistemas externos ao ambiente do cliente para consultar e movimentar dados sem depender do uso manual do painel.

Ela atende principalmente cenários de integração entre o xLumen e sistemas próprios do cliente, como sincronização de cadastros, criação de agendamentos e consulta de dados operacionais.

Gestão na aplicação

Section titled “Gestão na aplicação”

Na área Configurações > API, o administrador pode:

  • criar chave de API
  • regenerar chave de API
  • excluir chave de API

Essas operações controlam o acesso de integrações externas à API do tenant.

O que a API cobre

Section titled “O que a API cobre”

A documentação pública atual expõe recursos de três grupos:

  • clientes
  • calendário
  • WhatsApp

Recursos de clientes

Section titled “Recursos de clientes”

No grupo de clientes, a API permite:

  • listar clientes com paginação
  • buscar clientes por texto
  • filtrar clientes por tipo de pessoa
  • criar cliente
  • consultar cliente por ID
  • atualizar cliente
  • listar contatos de um cliente
  • criar contato para um cliente
  • consultar contato por ID
  • atualizar contato
  • excluir contato

Esse conjunto complementa o módulo de Clientes.

Recursos de calendário

Section titled “Recursos de calendário”

No grupo de calendário, a API permite:

  • listar agendamentos com paginação
  • filtrar agendamentos por período
  • filtrar agendamentos por cliente
  • filtrar agendamentos por prestador
  • consultar um agendamento por ID
  • consultar um agendamento por idExterno
  • criar agendamento
  • reagendar agendamento
  • concluir agendamento
  • cancelar agendamento

Esse conjunto complementa o módulo de Agenda.

Recursos de WhatsApp

Section titled “Recursos de WhatsApp”

No grupo de WhatsApp, a API permite que um sistema externo envie mensagens de template de WhatsApp sem passar pela Central de atendimento WhatsApp. Dá para:

  • listar os templates WABA aprovados disponíveis para envio
  • enviar um template aprovado para um contato já cadastrado

Antes de enviar, é preciso ter:

  • uma chave de API, criada em Configurações > API
  • um canal de atendimento WABA com pelo menos um template aprovado pela Meta; o status de cada template é acompanhado conforme Tutorial: acompanhar os templates no xLumen
  • o contato de destino já cadastrado no xLumen, conforme Clientes

Uma resposta 2xx no envio significa que a mensagem foi aceita e enfileirada para envio, não que ela foi entregue.

Os campos, as variáveis do template e os erros de cada chamada estão na referência técnica da API, em https://api.xlumen.com.br/api/v1/docs.

Regras visíveis na documentação pública

Section titled “Regras visíveis na documentação pública”

A documentação pública da API explicita, entre outras, estas regras:

  • a listagem de agendamentos é paginada
  • a consulta de agendamentos por período aceita janela máxima de 30 dias
  • a listagem de clientes é paginada
  • o agendamento pode usar idExterno como identificador de correlação com sistema externo

Documentação para desenvolvedor

Section titled “Documentação para desenvolvedor”

A referência técnica de endpoints, parâmetros e payloads fica em:

Perguntas frequentes

Section titled “Perguntas frequentes”

O que dá para integrar hoje pela API do xLumen?

Section titled “O que dá para integrar hoje pela API do xLumen?”

A documentação pública atual expõe operações de clientes, contatos de clientes, agendamentos e envio de templates de WhatsApp.

Como obtenho a chave de API?

Section titled “Como obtenho a chave de API?”

A chave é criada dentro da própria aplicação por um usuário administrador, na área Configurações > API. Nessa mesma área, o administrador também pode regenerar e excluir chaves.

A API permite integrar agenda e cadastro de clientes?

Section titled “A API permite integrar agenda e cadastro de clientes?”

Sim. A documentação pública atual cobre clientes, contatos de clientes, operações de agendamento e envio de templates de WhatsApp.

Posso enviar templates de WhatsApp pela API?

Section titled “Posso enviar templates de WhatsApp pela API?”

Sim, templates WABA aprovados pela Meta, para um contato já cadastrado no xLumen. A resposta 2xx indica que a mensagem foi aceita e enfileirada, não que foi entregue. Os campos e as variáveis do envio estão em https://api.xlumen.com.br/api/v1/docs.

Posso localizar um agendamento por um identificador do meu sistema?

Section titled “Posso localizar um agendamento por um identificador do meu sistema?”

Sim. A API expõe consulta de agendamento por idExterno, usado como chave de correlação com o sistema externo.

A API também avisa eventos automaticamente para outro sistema?

Section titled “A API também avisa eventos automaticamente para outro sistema?”

Para notificações automáticas de eventos, o xLumen oferece Webhooks. A API cobre consulta e movimentação de dados; os webhooks cobrem disparos automáticos quando eventos acontecem.