Início rápido

A Ligga API expõe os dados da sua conta (clientes, vendas, fornecedores, despesas e mais) em endpoints REST autenticados por chave de API. Este guia leva você da chave em mãos até a primeira listagem paginada.

Primeira chamada

Configure a chave e o endereço da API.

Guarde a chave em um cofre de segredos e exporte as duas variáveis que todos os exemplos deste site usam:
Terminal window
```
export LIGGA_API_KEY='ligga_live_…'
export LIGGA_BASE='https://api.ligga.app/functions/v1/api'
```
Toda requisição carrega a chave no cabeçalho Authorization:
```
Authorization: Bearer ligga_live_…
```

Valide a chave com GET /v1/me.

É a chamada mais leve da API e a forma recomendada de conferir que a chave funciona antes de escrever qualquer integração.

curl "$LIGGA_BASE/v1/me" \
  -H "Authorization: Bearer $LIGGA_API_KEY"

A resposta descreve a conta, os escopos da chave, os módulos habilitados e os limites de requisições em vigor:

{
  "data": {
    "team_id": "bca09e2f-41ab-4417-b84b-f2ff50f991ca",
    "team_name": "Pet Shop Aurora",
    "key_id": "c06d8705-f091-46e1-81bb-4a2cec656694",
    "key_name": "Integração ERP",
    "key_last4": "af0e",
    "key_prefix": "live",
    "scopes": ["*:read", "sales:write"],
    "plan_code": "pro",
    "modules": ["clientes", "vendas", "despesas", "agendamentos"],
    "rate_limits": {
      "burst_per_second": 10,
      "requests_per_minute_read": 300,
      "requests_per_minute_write": 120,
      "requests_per_day_total": 100000
    }
  },
  "meta": { "request_id": "req_01JZXQ8V2K5M7N9P0R1S2T3U4V" }
}

Guarde dois campos desta resposta: scopes diz o que a chave pode fazer e modules diz quais recursos a sua conta contratou.

Liste seus clientes.

curl "$LIGGA_BASE/v1/customers?limit=10" \
  -H "Authorization: Bearer $LIGGA_API_KEY"

Toda listagem devolve o mesmo envelope: os itens em data, o estado da paginação por cursor em pagination e o identificador da requisição em meta.

{
  "data": [],
  "pagination": { "next_cursor": "…", "has_more": true, "limit": 20 },
  "meta": { "request_id": "req_01JZXQ8V2K5M7N9P0R1S2T3U4V" }
}

Percorra as páginas seguintes.

Enquanto pagination.has_more for true, repita a chamada passando o valor de pagination.next_cursor em cursor:
Terminal window
```
curl "$LIGGA_BASE/v1/customers?limit=10&cursor=eyJpZCI6…" \
  -H "Authorization: Bearer $LIGGA_API_KEY"
```

Se algo der errado

Toda resposta de erro segue o mesmo formato, com o campo type apontando para a página do erro e o request_id que identifica a requisição nos registros da Ligga.

HTTP	`type`	O que fazer
401	`invalid_token`	Confira o cabeçalho `Authorization` e o valor de `LIGGA_API_KEY`
403	`api_disabled`	A API ainda não foi liberada para a sua conta; fale com o time da Ligga
403	`insufficient_scope`	A chave não carrega o escopo que o endpoint exige
403	`module_not_enabled`	O recurso depende de um módulo fora do seu plano
429	`rate-limit-exceeded`	Espere o intervalo indicado nos cabeçalhos `X-RateLimit-*`

Veja também

Autenticação — formato das chaves, escopos e restrição por IP
Módulos e escopos — qual módulo cada recurso exige
Paginação, filtros e ordenação — como percorrer listagens grandes
Sua conta (me) — todos os campos de GET /v1/me