API REST

A API REST interna alimenta o Vue SPA e os scripts do operador, automatizando diagnósticos ou clonagem.

Base e versionamento

• Caminho: /custom/knotmigration/api/
• Nenhum prefixo /v1/ no URL
• Cabeçalho obrigatório: Knot-Migration-API-Versão: 2026-05-01

Autenticação

• Cookie de sessão Dolibarr válido
• Token CSRF X-Dolibarr-CSRF em POST/PUT/PATCH/Eliminar
• Capacidades: knotmigration.use, knotmigration.clone, knotmigration.admin

Envelope de sucesso

{
  "data": { },
  "meta": { "request_id": "req_abc123", "generated_at": "2026-05-17T10:42:00Z" }
}

Envelope de erro

{
  "error": "human-readable explanation",
  "code": "KM_API_*",
  "request_id": "req_abc123"
}

Endpoints sensíveis passam por api/_license_guard_bootstrap.php.

Próximo

Licenciamento licença_not_usable guarda.