Módulos e escopos

O acesso à API acompanha o seu plano. Cada recurso está vinculado a um módulo do Monte seu Plano: com o módulo habilitado no contrato, o recurso responde normalmente, respeitando os escopos da chave; sem o módulo, a resposta é 403 module_not_enabled.

São duas camadas independentes, e as duas precisam permitir a operação:

1. Escopo da chave — o que esta chave pode fazer (sales:read, customers:write, *:read). Definido quando a chave é criada.
2. Módulo do contrato — o que a sua conta contratou. Definido pelo plano.

Matriz recurso e módulo

O código do módulo é o valor que GET /v1/me devolve na lista modules.

Recurso	Identificador	Endpoints	Módulo	Código do módulo	Operações
Clientes	customers	/v1/customers	Clientes	clientes	leitura e escrita
Vendas	sales	/v1/sales	Vendas	vendas	leitura e escrita
Fornecedores	suppliers	/v1/suppliers	Fornecedores	fornecedores	leitura e escrita
Despesas	expenses	/v1/expenses	Despesas	despesas	leitura e escrita
Agendamentos	appointments	/v1/appointments	Agendamentos	agendamentos	leitura
Serviços	services	/v1/services	Agendamentos	agendamentos	leitura
Produtos	products	/v1/products	Catálogo	catalogo	leitura
Estoque	inventory	/v1/inventory	Estoque	estoque	leitura
Contas bancárias	bank-accounts	/v1/bank-accounts	Contas bancárias	contas_bancarias	leitura
Projetos	projects	/v1/projects	Projetos	projetos	leitura
Oportunidades	deals	/v1/deals e /v1/deals/stages	CRM (funil)	crm_funil	leitura
Formulários	forms	/v1/forms	Formulários	formularios	leitura
Veículos	vehicles	/v1/vehicles	Veículos	veiculos	leitura
Pets	pets	/v1/pets	Pets	pets	leitura

Sua conta (me) é a exceção: GET /v1/me não depende de módulo nenhum e responde em qualquer conta com a API habilitada.

Nota

Por que dez recursos são somente leitura. A escrita nesses módulos depende de regras de negócio do aplicativo, como disponibilidade de agenda, movimentação de estoque e etapas do funil. Expor a criação sem essas regras produziria dados inconsistentes. A escrita entra recurso a recurso conforme a demanda: peça o seu no quadro de Sugestões.

Em avaliação

Recurso	Endpoints previstos	Módulo
transactions	/v1/transactions	Contas bancárias, com o extrato de cada conta
escrita nos recursos somente leitura acima	—	conforme a demanda

Como ver os módulos da sua conta

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

{
  "data": {
    "plan_code": "pro",
    "scopes": ["*:read", "sales:write"],
    "modules": ["clientes", "vendas", "despesas", "agendamentos"],
    "rate_limits": { "burst_per_second": 10 }
  },
  "meta": { "request_id": "req_01JZXQ8V2K5M7N9P0R1S2T3U4V" }
}

Compare a lista modules com a coluna “Código do módulo” da matriz acima para saber quais recursos a sua chave alcança.

Dica

Um módulo habilitado agora no contrato passa a valer na API em até cinco minutos, o tempo do cache.

Erros relacionados

HTTP	type	Significado	O que fazer
403	api_disabled	A conta ainda não tem a API habilitada	Fale com o time da Ligga
403	module_not_enabled	O recurso depende de um módulo fora do plano	Habilite o módulo no Monte seu Plano ou ajuste a integração
403	insufficient_scope	O módulo está habilitado, mas a chave não tem o escopo	Peça uma chave com o escopo necessário

Veja também

• Autenticação — o que cada escopo concede
• Início rápido — a primeira chamada, passo a passo
• Sua conta (me) — todos os campos de GET /v1/me
• Erros — o catálogo completo e o formato do corpo