Pular para o conteúdo principal
LLMs.md

API e exportações

Existem duas maneiras de transferir dados do LiteLog para outros sistemas:

  1. REST API v1 — para sistemas de terceiros que se comunicam automaticamente com o LiteLog: por exemplo, B. um sistema de gerenciamento de propriedade (PMS) que cria uma tarefa de limpeza durante o check-out do hóspede ou um middleware que sincroniza os dados mestre da propriedade.
  2. Exportações de CSV e PDF — para folha de pagamento, relatórios e envio a clientes, sem linha de código. Consulte Exportação e envio.

API REST v1

Criar chave de API

Você gerencia chaves de API no portal em Configurações → Integrações no cartão REST API:

  1. Clique em Criar chave e atribua um nome (por exemplo, “apartamentos de férias PMS”).
  2. Escolha as Permissões (Escopos) que você deseja que a chave tenha, apenas o necessário.
  3. A chave bruta (ll_live_…) é exibida exatamente uma vez. Copie-o e guarde-o com segurança — depois disso, apenas o início da chave ficará visível.

Integrações

Uma chave está vinculada ao seu cliente e um acesso - ela vê exatamente os objetos que esse acesso vê. A revogação entra em vigor imediatamente; para rotação sem falhas, primeiro crie a nova chave, converta o sistema de terceiros e depois revogue o antigo.

Autenticação

Cada solicitação carrega a chave no cabeçalho — como X-Api-Key ou como token de portador:

curl -H "X-Api-Key: ll_live_..." https://api.litelog.de/api/v1/me
# oder
curl -H "Authorization: Bearer ll_live_..." https://api.litelog.de/api/v1/me

GET /v1/me é adequado como primeiro teste: o endpoint retorna o contexto da chave (cliente, escopos) sem exigir permissões adicionais.

Pontos finais

Método e caminhoPropósitoEscopo necessário
CÓDIGO0Chave de teste: contexto próprio (cliente, escopos)-
CÓDIGO0Listar objetosCÓDIGO0
CÓDIGO0Criar objetoCÓDIGO0
CÓDIGO0Atualizar objetoCÓDIGO0
CÓDIGO0Listar tarefasCÓDIGO0
CÓDIGO0Criar tarefa (idempotente via uuid fornecido)CÓDIGO0
CÓDIGO0Crie um relatório (incidente/defeito).CÓDIGO0
CÓDIGO0Consultar respostas de formulário enviadas (sondagem)CÓDIGO0
CÓDIGO0Resposta do formulário em detalhes, incluindo respostas e links para fotosCÓDIGO0

:::tip Idempotenz Ao criar tarefas, insira seu próprio uuid - entregas repetidas do mesmo evento (por exemplo, reentrega de webhook do seu PMS) nunca criarão duas tarefas. :::

Exemplo: “Convidado sai → tarefa de limpeza”

# Checkout-Event → Reinigungsaufgabe
curl -X POST https://api.litelog.de/api/v1/tasks \
-H "X-Api-Key: $KEY" -H "Content-Type: application/json" \
-d '{"uuid":"7c9e6679-7425-40de-944b-e07fc1f90ae7","title":"Endreinigung Wohnung 3","property_id":123,"due_date":"2026-08-01"}'

# Fertige Reinigungs-Checkliste abfragen (Polling)
curl "https://api.litelog.de/api/v1/form-responses?property_id=123&status=submitted&pageSize=10" \
-H "X-Api-Key: $KEY"

Limites e Comportamento

  • Limite de taxa: 120 solicitações por minuto por chave (HTTP 429 se excedido).
  • Sem licença: os acessos à API não ocupam licença. Uma licença expirada bloqueia o acesso de gravação (a leitura permanece possível, HTTP 402 durante a gravação).
  • Formato do erro: 401 (Chave ausente/inválida/revogada), 403 (Escopo ou acesso ao objeto ausente), 404 (Recurso não presente), 409 (Conflito/Duplicado), 400/422 (Erro de validação - campos desconhecidos são rejeitados).
  • Ainda não incluído: Webhooks de saída (planejados — até então pesquisa via GET /api/v1/form-responses?status=submitted), OAuth2, rastreamento de tempo de gravação ou respostas de formulário, uploads de arquivos e endpoints DELETE.

Exportações de CSV e PDF

Você não precisa de uma API para folha de pagamento e relatórios — as exportações integradas cobrem os casos mais comuns:

  • Horários de trabalho como CSV — por ex. B. a matriz de frequência diária por pessoa para folha de pagamento.
  • Relatórios em PDF — relatórios de tours, notificações e formulários, em seu próprio Marca mediante solicitação.
  • Entrega recorrente de e-mail — Relatórios automáticos, por exemplo. B. enviar semanalmente aos clientes.

Todos os detalhes: Exportação e envio e Objeto — Envio.

Permissões

:::info Berechtigung Para criar e revogar chaves de API, você precisa da permissão Editar configurações. O que uma chave pode ver e alterar também é limitado pelo seu escopo e pelo acesso ao qual está vinculada. :::

Páginas relacionadas