> ## 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 autorizam o acesso a produtos e plugins pagos da Lerian, com tipos de licença por organização e globais.

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

No ecossistema da Lerian, as licenças desempenham um papel crítico em:

* Garantir que os clientes estejam em situação regular antes de acessar recursos pagos, como **produtos**, **plugins ou recursos enterprise**.
* Gerenciar quais recursos estão disponíveis por cliente.
* Permitir que a Lerian escale operações de suporte e vendas de forma segura e eficiente.

Em resumo, apenas clientes com licenças válidas, conforme definido em seus contratos, podem acessar componentes de software específicos.

<Danger>
  Uma licença válida deve estar associada à organização que está fazendo a requisição. 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 por organização (não globais)

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

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

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

### Licenças globais

Válidas para **várias organizações**.

Exemplo: **Access Manager.**

## Fluxo de uso da licença

***

Os passos 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 por organização**: forneça o `organization_id` que utilizará a licença.
    * **Para plugins globais**: informe à Lerian que você precisa de uma licença global; nenhum `organization_id` é necessário.
  </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 detalhes 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">
    Ao 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 por 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 possuem 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**: Deve ser definido como `global` para licenças globais.

## Erros relacionados à licença

***

Quando uma licença é inválida ou expirada, respostas da API ou comportamentos de plugins podem retornar uma das mensagens de erro específicas:

| Code     | Title                                        | Message                                                                                                                                                                                                                                          |
| :------- | :------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| LCS-0001 | Internal server error                        | An internal server error occurred. Please try again later or contact support if the problem persists.                                                                                                                                            |
| LCS-0002 | No organization IDs configured               | The application is not configured with any organization IDs.                                                                                                                                                                                     |
| LCS-0003 | No valid licenses found for any organization | No valid licenses were found for any of the configured organizations. Please check your license keys and ensure at least one organization has a valid license.                                                                                   |
| LCS-0010 | Organization ID header is missing            | The X-Organization-ID header is missing. Please ensure the header is included in the request.                                                                                                                                                    |
| LCS-0011 | Organization ID header is unknown            | The organization ID '12345' was not found in the list of configured organizations. Please verify you are using a valid organization ID.                                                                                                          |
| LCS-0012 | Failed to validate organization license      | License validation failed for organization ID 12345. This could be due to network issues, invalid license keys, or server-side problems. Please verify your license key is correct and that you have network connectivity to the license server. |
| LCS-0013 | Organization license is invalid              | The license for organization ID '12345' is not valid and has no grace period active. Please renew your license or contact support for assistance.                                                                                                |
| LCS-1001 | Validation error                             | Could not validate license key. Please try again later or contact your system administrator.                                                                                                                                                     |
| LCS-1002 | License not found                            | There is no license for this license key.                                                                                                                                                                                                        |
| LCS-1003 | License expired                              | The license key has expired.                                                                                                                                                                                                                     |
| LCS-1004 | License suspended                            | The license key has been suspended due to payment issues or administrative action.                                                                                                                                                               |
| LCS-1005 | Fingerprint mismatch                         | The license key or organization ID are not valid for this license.                                                                                                                                                                               |
| LCS-1006 | Product mismatch                             | There is no license for this product.                                                                                                                                                                                                            |

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