Skip to main content
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
FXXOne

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