# Ligga API

> API REST pública da Ligga (plataforma brasileira de gestão para pequenos
> negócios). Autenticação por chave de API (`Authorization: Bearer ligga_live_…`),
> respostas JSON, erros em `application/problem+json` (RFC 7807), paginação por
> cursor, limites de requisição por plano e acesso a cada recurso condicionado ao
> módulo do Monte seu Plano contratado pela conta.

URL base: https://api.ligga.app/functions/v1/api — o caminho começa em `/v1`,
por exemplo `https://api.ligga.app/functions/v1/api/v1/customers`.

## Início

- [Início](https://docs.ligga.app/): o que a API expõe e por onde começar

## Guias

- [Início rápido](https://docs.ligga.app/guides/quickstart/): a primeira chamada, passo a passo
- [Autenticação](https://docs.ligga.app/guides/auth/): formato das chaves (`ligga_live_`, `ligga_test_`, checksum CRC32) e escopos `:read` e `:write` por recurso
- [Módulos e escopos](https://docs.ligga.app/guides/modules/): matriz recurso→módulo do Monte seu Plano; erros `api_disabled` e `module_not_enabled`
- [Modo teste](https://docs.ligga.app/guides/sandbox/): o que a chave `ligga_test_` faz hoje — ela usa a mesma base de produção, não é um ambiente isolado
- [Paginação, filtros e ordenação](https://docs.ligga.app/guides/pagination/): cursor em `pagination.next_cursor`, `limit` de 1 a 100 (padrão 20), `filter[campo][operador]`, `sort`, `fields`, `include`
- [Idempotência](https://docs.ligga.app/guides/idempotency/): cabeçalho `Idempotency-Key` nos `POST`
- [Erros](https://docs.ligga.app/guides/errors/): corpo RFC 7807 com `type`, `title`, `status`, `request_id`; cabeçalho `X-Request-Id`
- [Limites de requisições](https://docs.ligga.app/guides/rate-limits/): tetos por segundo, por minuto (leitura e escrita) e por dia; cabeçalhos `X-RateLimit-*`; `429` com `Retry-After`
- [Formatos de identificador](https://docs.ligga.app/guides/ids/): UUID nos `id`, formato do cursor
- Exemplos por linguagem: [cURL](https://docs.ligga.app/guides/sdks/curl/) · [Node.js](https://docs.ligga.app/guides/sdks/node/) · [Python](https://docs.ligga.app/guides/sdks/python/) · [PHP](https://docs.ligga.app/guides/sdks/php/) · [n8n](https://docs.ligga.app/guides/sdks/n8n/)

## Recursos

Formato: rota — Nome (identificador) · módulo · operações · página.
O identificador é o mesmo no segmento da rota, no escopo (`customers:read`), na
tag do OpenAPI e no slug da página.

- /v1/me — Sua conta (me) · sem módulo · leitura · https://docs.ligga.app/resources/me/
- /v1/customers — Clientes (customers) · módulo `clientes` · leitura e escrita · https://docs.ligga.app/resources/customers/
- /v1/sales — Vendas (sales) · módulo `vendas` · leitura e escrita · https://docs.ligga.app/resources/sales/
- /v1/suppliers — Fornecedores (suppliers) · módulo `fornecedores` · leitura e escrita · https://docs.ligga.app/resources/suppliers/
- /v1/expenses — Despesas (expenses) · módulo `despesas` · leitura e escrita · https://docs.ligga.app/resources/expenses/
- /v1/appointments — Agendamentos (appointments) · módulo `agendamentos` · leitura · https://docs.ligga.app/resources/appointments/
- /v1/services — Serviços (services) · módulo `agendamentos` · leitura · https://docs.ligga.app/resources/services/
- /v1/products — Produtos (products) · módulo `catalogo` · leitura · https://docs.ligga.app/resources/products/
- /v1/inventory — Estoque (inventory) · módulo `estoque` · leitura · https://docs.ligga.app/resources/inventory/
- /v1/bank-accounts — Contas bancárias (bank-accounts) · módulo `contas_bancarias` · leitura · https://docs.ligga.app/resources/bank-accounts/
- /v1/projects — Projetos (projects) · módulo `projetos` · leitura · https://docs.ligga.app/resources/projects/
- /v1/deals — Oportunidades (deals) · módulo `crm_funil` · leitura (inclui /v1/deals/stages) · https://docs.ligga.app/resources/deals/
- /v1/forms — Formulários (forms) · módulo `formularios` · leitura · https://docs.ligga.app/resources/forms/
- /v1/vehicles — Veículos (vehicles) · módulo `veiculos` · leitura · https://docs.ligga.app/resources/vehicles/
- /v1/pets — Pets (pets) · módulo `pets` · leitura · https://docs.ligga.app/resources/pets/

Nos recursos de leitura, a escrita entra conforme a demanda.

## Referência

- [Referência da API](https://docs.ligga.app/reference/): OpenAPI 3.1, todos os endpoints, com teste na própria página
- [Documento OpenAPI](https://docs.ligga.app/openapi.json)

## Receitas

- [Receitas](https://docs.ligga.app/recipes/): índice
- [Importar clientes via CSV](https://docs.ligga.app/recipes/import-customers-csv/)
- [Criar venda com itens](https://docs.ligga.app/recipes/create-sale-with-items/)
- [Sincronizar fornecedores via n8n](https://docs.ligga.app/recipes/sync-suppliers-n8n/)

## Changelog

- [Changelog](https://docs.ligga.app/changelog/)

## Sugestões

- [Sugestões](https://docs.ligga.app/sugestoes/): board público de pedidos de recurso