> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Licença da Lerian

> As licenças da Lerian autorizam o acesso a produtos e plugins pagos, com tipos de licença por organização e globais, além de regras de ativação e validação.

Uma **licença** é uma chave que autoriza o acesso a funcionalidades ou serviços da Lerian sob condições contratuais específicas, geralmente alinhadas a ciclos de cobrança (por exemplo, mensal, anual). Esse mecanismo é semelhante a como produtos de software como o Microsoft Office ou o GitHub Enterprise gerenciam o acesso por meio de chaves de ativação.

No ecossistema da Lerian, as licenças:

* Confirmam que os clientes estão em situação regular antes de acessarem funcionalidades pagas, como **produtos**, **plugins ou funcionalidades enterprise**.
* Gerenciam quais funcionalidades estão disponíveis por cliente.
* Permitem que a Lerian escale as operações de suporte e vendas.

Apenas clientes com licenças válidas, conforme definido em seus contratos, podem acessar componentes específicos do software.

<Danger>
  A organização que faz a requisição deve ter uma licença válida. Caso contrário, o acesso será negado.
</Danger>

## Tipos de licença

***

No ecossistema da Lerian, as licenças podem ter dois escopos diferentes, dependendo do plugin:

### Licenças específicas de organização (não globais)

Aplica-se a uma **única organização**.

Exemplo: **Fees Engine**, **Reporter**.

<Tip>
  Você pode usar a licença com qualquer número de ledgers dentro dessa organização.
</Tip>

### Licenças globais

Válida para **múltiplas organizações**.

Exemplo: **Access Manager.**

## Workflow de uso da licença

***

As etapas abaixo se aplicam a ambos os tipos de licença:

<Steps>
  <Step title="Envie uma solicitação de licença para a Lerian.">
    * **Para plugins específicos de organização**: informe o `organization_id` que usará a licença.
    * **Para plugins globais**: informe à Lerian que você precisa de uma licença global. Você não precisa de um `organization_id`.
  </Step>

  <Step title="Geração e ativação da licença pela Lerian">
    A equipe da Lerian segue o processo interno para criar e ativar a licença usando os dados fornecidos.
  </Step>

  <Step title="Entrega da chave de licença">
    A Lerian envia a **Chave de Licença** (`LICENSE_KEY`) para o cliente.
  </Step>

  <Step title="Configuração do ambiente">
    Depois de receber sua chave de licença, você deve configurar seu arquivo `.env` para que o sistema saiba **qual licença validar** e **a quais organizações ela se aplica**.
  </Step>
</Steps>

<Warning>
  Sempre configure as variáveis de ambiente corretas antes de usar um plugin. Valores incorretos ou ausentes resultarão em erros de validação de licença.
</Warning>

**Licenças específicas de organização (não globais)**

Essas licenças se aplicam a apenas uma organização.

<CodeGroup>
  ```bash Bash theme={null}
  # LICENSE
  LICENSE_KEY=<license key>
  ORGANIZATION_IDS=<organization-id1>,<organization-id2>
  ```
</CodeGroup>

* **LICENSE\_KEY**: a chave fornecida pela Lerian.
* **ORGANIZATION\_IDS**: o ID da organização vinculada à licença.

**Licenças globais**

Essas licenças têm escopo global e devem **sempre** usar o valor `global` na variável `ORGANIZATION_IDS`.

<CodeGroup>
  ```bash Bash theme={null}
  # LICENSE
  LICENSE_KEY=<license key>
  ORGANIZATION_IDS=global
  ```
</CodeGroup>

* **LICENSE\_KEY**: a chave fornecida pela Lerian.
* **ORGANIZATION\_IDS**: use o valor `global` para licenças globais.

## Erros relacionados a licença

***

Para uma licença inválida ou expirada, as respostas da API ou o comportamento dos plugins podem retornar uma destas mensagens de erro:

| Código   | Título                                                     | Mensagem                                                                                                                                                                                                                                                                            |
| :------- | :--------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| LCS-0001 | Erro interno do servidor                                   | Ocorreu um erro interno do servidor. Tente novamente mais tarde ou entre em contato com o suporte se o problema persistir.                                                                                                                                                          |
| LCS-0002 | Nenhum ID de organização configurado                       | O aplicativo não está configurado com nenhum ID de organização.                                                                                                                                                                                                                     |
| LCS-0003 | Nenhuma licença válida encontrada para nenhuma organização | Nenhuma licença válida foi encontrada para nenhuma das organizações configuradas. Verifique suas chaves de licença e garanta que pelo menos uma organização tenha uma licença válida.                                                                                               |
| LCS-0010 | O header Organization ID está ausente                      | O header X-Organization-ID está ausente. Garanta que o header esteja incluído na requisição.                                                                                                                                                                                        |
| LCS-0011 | O header Organization ID é desconhecido                    | O ID de organização '12345' não foi encontrado na lista de organizações configuradas. Verifique se você está usando um ID de organização válido.                                                                                                                                    |
| LCS-0012 | Falha ao validar a licença da organização                  | A validação da licença falhou para o ID de organização 12345. Isso pode ocorrer por problemas de rede, chaves de licença inválidas ou problemas no lado do servidor. Verifique se sua chave de licença está correta e se você tem conectividade de rede com o servidor de licenças. |
| LCS-0013 | A licença da organização é inválida                        | A licença do ID de organização '12345' não é válida e não tem nenhum período de carência ativo. Renove sua licença ou entre em contato com o suporte para obter ajuda.                                                                                                              |
| LCS-1001 | Erro de validação                                          | Não foi possível validar a chave de licença. Tente novamente mais tarde ou entre em contato com o administrador do sistema.                                                                                                                                                         |
| LCS-1002 | Licença não encontrada                                     | Não há nenhuma licença para esta chave de licença. Garanta que a chave de licença esteja correta e tente novamente.                                                                                                                                                                 |
| LCS-1003 | Licença expirada                                           | A chave de licença expirou. Entre em contato com o administrador do sistema para renovar sua licença.                                                                                                                                                                               |
| LCS-1004 | Licença suspensa                                           | A chave de licença foi suspensa devido a problemas de pagamento ou ação administrativa. Entre em contato com o administrador do sistema.                                                                                                                                            |
| LCS-1005 | Incompatibilidade de fingerprint                           | A chave de licença ou os IDs de organização não são válidos para esta licença. Garanta que a chave de licença e os IDs de organização estejam corretos e tente novamente.                                                                                                           |
| LCS-1006 | Incompatibilidade de produto                               | Não há nenhuma licença para este produto. Garanta que a chave de licença esteja correta e tente novamente.                                                                                                                                                                          |

<Tip>
  Para mais informações sobre sua licença ou para solicitar um upgrade, entre em contato com a equipe comercial da Lerian.
</Tip>
