> ## 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.

# Configurando o Lerian Cabine

> Os endereços dos serviços e as configurações da instituição que o Lerian Cabine lê em tempo de execução.

O Lerian Cabine lê os endereços dos serviços e as configurações da instituição em tempo de execução. O deploy serve um script que define `window.__CABINE_CONFIG__` antes de o Cabine iniciar. Uma instalação atende uma instituição.

```js theme={null}
window.__CABINE_CONFIG__ = {
  VITE_AUTH_URL: "https://auth.example.com/v1",
  VITE_DESK_URL: "https://cabine-api.example.com",
  VITE_FI_ISPB: "12345678",
};
```

## Como o Cabine lê uma chave

O Cabine resolve cada chave nesta ordem:

1. O valor em `window.__CABINE_CONFIG__`, quando a chave está lá e é válida.
2. O valor definido quando o bundle do Cabine foi construído, quando `window.__CABINE_CONFIG__` não traz a chave.
3. Não definida.

Uma string vazia é válida. Ela deixa a chave sem valor e oculta o valor do build. Um valor que não é válido é tratado como não definido. Ele também oculta o valor do build, então um erro de digitação não volta para um endereço de outro ambiente. O Cabine remove os espaços de um valor em tempo de execução. O Cabine lê apenas as chaves de tempo de execução permitidas e ignora as demais.

| Tipo | Valor válido |
| - | - |
| Endereço | Uma URL `http` ou `https`, sem usuário, senha, query nem fragmento. |
| ISPB | Exatamente 8 caracteres, cada um um dígito ou uma letra maiúscula. |
| Identificador | Até 256 caracteres, sem caractere de controle. |
| Montante | Dígitos com uma parte decimal opcional, por exemplo `65000000.00`. |

## Endereços do Access Manager e da API do Cabine

O Cabine acrescenta o caminho da rota a cada endereço.

| Chave | O que define | Valor |
| - | - | - |
| `VITE_AUTH_URL` | O serviço de autenticação do Access Manager: login, renovação do token e a etapa do código (MFA). | Termina em `/v1`. |
| `VITE_IDENTITY_URL` | O serviço de identidade do Access Manager: usuários e grupos. Veja [Serviço Identity](https://docs.lerian.studio/pt/platform/access-manager/identity-plugin.md). | Termina em `/v1`. |
| `VITE_DESK_URL` | A API do Cabine. Sem ela, o Cabine não chama a API do Cabine. | Origem. |

## Endereços dos trilhos

Sem o endereço de um trilho, o Cabine não consegue chamar esse trilho.

| Chave | O que define | Valor |
| - | - | - |
| `VITE_SPB_URL` | O Lerian SPB. | Origem. |
| `VITE_SPI_URL` | O Lerian SPI. | Origem. |
| `VITE_DICT_URL` | O serviço DICT do Lerian SPI. Quando não definida, o Cabine usa `VITE_SPI_URL`. | Origem. |
| `VITE_BRCODE_URL` | O serviço BR Code do Lerian SPI. Quando não definida, o Cabine usa `VITE_SPI_URL`. | Origem. |
| `VITE_CORE_URL` | O serviço core do Lerian SPI. Quando não definida, o Cabine usa `VITE_SPI_URL`. | Origem. |
| `VITE_SILOC_URL` | O Lerian SILOC. | Origem. |
| `VITE_CORREIOS_URL` | O Lerian BC Correios. | Termina em `/api/v1/correios`. |
| `VITE_STA_URL` | O Lerian STA. | Origem. |
| `VITE_CCS_URL` | O Lerian CCS. | Origem. |
| `VITE_SRC_URL` | O Lerian SRC. | Origem. |
| `VITE_SISBAJUD_URL` | O Lerian SISBAJUD. | Origem. |
| `VITE_SCR_URL` | O Lerian SCR. | Origem. |

## Endereços de readiness

O Cabine lê a readiness de um trilho em `/readyz` no endereço de readiness. O Cabine deixa de fora um trilho que não tem endereço. Quando uma chave de readiness não está definida, o Cabine usa o endereço da última coluna.

| Chave | Trilho | Alternativa |
| - | - | - |
| `VITE_READYZ_SPB_URL` | Lerian SPB | `VITE_SPB_URL` |
| `VITE_READYZ_SPI_URL` | Lerian SPI | `VITE_SPI_URL` |
| `VITE_READYZ_DICT_URL` | O serviço DICT do Lerian SPI | `VITE_DICT_URL`, depois `VITE_SPI_URL` |
| `VITE_READYZ_BRCODE_URL` | O serviço BR Code do Lerian SPI | `VITE_BRCODE_URL`, depois `VITE_SPI_URL` |
| `VITE_READYZ_CORE_URL` | O serviço core do Lerian SPI | `VITE_CORE_URL`, depois `VITE_SPI_URL` |
| `VITE_READYZ_CORREIOS_URL` | Lerian BC Correios | A origem de `VITE_CORREIOS_URL` |
| `VITE_READYZ_SILOC_URL` | Lerian SILOC | `VITE_SILOC_URL` |
| `VITE_READYZ_STA_URL` | Lerian STA | `VITE_STA_URL` |
| `VITE_READYZ_CCS_URL` | Lerian CCS | `VITE_CCS_URL` |
| `VITE_READYZ_SRC_URL` | Lerian SRC | `VITE_SRC_URL` |
| `VITE_READYZ_SISBAJUD_URL` | Lerian SISBAJUD | `VITE_SISBAJUD_URL` |
| `VITE_READYZ_SCR_URL` | Lerian SCR | `VITE_SCR_URL` |

## Instituição

| Chave | O que define | Valor |
| - | - | - |
| `VITE_FI_ISPB` | O ISPB da instituição. O Cabine o coloca nos formulários e nas ações que nomeiam a instituição. Sem ele, esses formulários ficam incompletos. | ISPB |
| `VITE_SISBAJUD_INSTITUTION_ID` | A instituição do Lerian SISBAJUD que o Cabine lê. Sem ela, o Cabine não faz nenhuma leitura do SISBAJUD. | Identificador |

## Pisos

| Chave | O que define | Valor |
| - | - | - |
| `VITE_RESERVE_FLOOR_BRL` | O piso padrão da reserva, em BRL. | Montante |
| `VITE_CONTA_PI_FLOOR_BRL` | O limiar padrão da Conta PI, em BRL. | Montante |

Os pisos que um operador define são salvos apenas naquele navegador. Eles substituem o padrão do deploy naquele navegador.

Um operador define os pisos na página **Configuração** das áreas de trabalho STR e SPI, nos campos **Piso da reserva** e **Limiar da Conta PI**, e salva com **Salvar**. Cada campo aceita até duas casas decimais. Limpar um campo volta ao padrão do deploy. Sem padrão, o alerta para.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.