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

# Primeiros passos

Este documento descreve os passos necessários para realizar as primeiras chamadas à API da Flexxible.

## Ambientes

O acesso à API pode variar em função do ambiente.

### URL base

Todas as rotas da API são construídas a partir desta base:

**Flexxible**

```
https://api.flexxible.net
```

**FXXOne**

```
https://api.one.flexxible.net
```

## Gerar uma chave de API

Para criar essa chave, é necessário que o usuário tenha o papel de **Administrador de organização**.

1. Acessar **Configurações** → **Organização**.

2. Selecionar a aba **Chaves de API**.

3. Clicar em **Criar chave de API**.

4. Preencher o formulário.
   * **Nome.** Identificador da chave de API.
   * **Papel.** Papel atribuído ao usuário no Portal.
   * **Duração.** Tempo de validade da chave.

5. Confirmar com **Salvar**.

## Autenticar as solicitações

Todas as requisições devem incluir a chave no cabeçalho **Authentication** utilizando o esquema Bearer:

**Authentication**: Bearer `<api_key>`

Embora seja utilizado o esquema Bearer, o valor corresponde diretamente a uma chave de API gerada na plataforma, e não a um token obtido por meio de um processo de autenticação adicional.

## Obter o ID da organização

Cada endpoint requer o ID da organização como primeiro segmento da rota.

`https://api.flexxible.net/v2/organizations/:organization_id/{endpoint}`

Para encontrar o ID da organização:

1. Acessar **Configurações** → **Organização**.
2. Selecionar a aba **Geral** → **Detalhes**.
3. Copiar o identificador.

## Contrato OpenAPI

[Baixe o contrato OpenAPI](openapi-contracts-pt-BR.zip) em formato JSON para consultar a especificação completa da API e facilitar as integrações.

## Limites

Para garantir a estabilidade, o desempenho e a disponibilidade do serviço, a plataforma aplica limites lógicos ao número máximo de itens que um tenant pode armazenar de cada entidade disponível na API.

Esses limites não correspondem a limites de requisições à API (rate limits), mas definem a quantidade máxima de itens de cada tipo de entidade que um tenant pode ter em um determinado momento.

Tais limites são aplicados por padrão em todos os ambientes.

| Entidade                           | Limite de itens |
| ---------------------------------- | --------------: |
| Tenants e tenants delegados        |             100 |
| Organizações                       |             100 |
| Grupos de relatório                |             500 |
| Grupos de workspaces               |            1000 |
| Grupos de workspaces → Agendamento |              10 |
| Fluxos                             |             100 |
| Microsserviços                     |             500 |
| Relatórios                         |             500 |
| Web Apps                           |             100 |
| Webhooks                           |             100 |
| Licenças                           |             500 |
| Configuração de alertas            |             100 |
| Papéis                             |             100 |
| Usuários                           |            1500 |
| Atualizações → Diretivas           |              50 |
| Atualizações → Targets             |              50 |
| Diretivas                          |              50 |
| Integrações                        |              10 |
| Categorias de relatórios           |             100 |
| Categorias de microsserviços       |             100 |
| Domínios                           |               5 |
| Integrações SSO                    |               5 |
| Produtos                           |              15 |
| Módulos                            |              50 |
| API Keys                           |              15 |