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:
https://api.one.flexxible.net
Gerar uma chave de API
Para criar esta chave, é necessário que o usuário tenha o papel de Administrador de Organização.
-
Acessar o Portal.
-
No menu lateral, clique em
Configuração→Organização. -
Selecionar a aba
Chaves de API.
-
Clique em
Criar chave de API. -
Preencha o formulário.
- Nome. Identificador da chave API.
- Papel. Papel atribuído ao usuário no Portal.
- Duração. Tempo de validade da chave.
-
Confirme com
Salvar.
Autenticar as solicitações
Todas as solicitações devem incluir a chave no cabeçalho Authentication usando o esquema Bearer:
Autenticação: Bearer <api_key>
Embora o esquema Bearer seja utilizado, o valor corresponde diretamente a uma chave de API gerada no Portal, não a um token obtido através de um processo de autenticação adicional.
Obter o ID da organização
Cada endpoint requer o ID da organização como o primeiro segmento de rota.
https://api.flexxible.net/v2/organizations/:organization_id/{endpoint}
Para encontrar o ID da organização:
-
Acessar
Portal->Configuração->Organização. -
Selecionar a aba
Geral->Detalhes. -
Copiar o identificador.
Contrato OpenAPI
Baixar o contrato OpenAPI 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 elementos que um tenant pode armazenar de cada entidade disponível na API. Esses limites não correspondem a limites de solicitações à API (rate limits), mas definem a quantidade máxima de elementos de cada tipo de entidade que um tenant pode ter em um determinado momento.
Esses limites são aplicados por padrão em todos os ambientes.
| Entidade | Limite de elementos |
|---|---|
| Tenants e tenants delegados | 100 |
| Organizações | 100 |
| Grupos de relatório | 500 |
| Grupos de workspaces | 1000 |
| Grupos de workspaces → Programação | 10 |
| Fluxos | 100 |
| Microserviços | 500 |
| Informes | 500 |
| Web Apps | 100 |
| Webhooks | 100 |
| Licenças | 500 |
| Configuração de alertas | 100 |
| Funções | 100 |
| Usuários | 1500 |
| Atualizações → Diretrizes | 50 |
| Atualizações → Alvos | 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 |
| Chaves de API | 15 |