Referência da API

A API REST da Flowtly — 927 endpoints em 192 recursos, gerados a partir do esquema OpenAPI atual.

Esta referência é gerada a partir do esquema da API. As descrições dos campos e qualquer texto ainda não traduzido são apresentados em inglês.

Inicie um teste para obter um token Falar com a equipa comercial

Antes de começar a construir

Autenticação

Envie um token de acesso pessoal no cabeçalho Authorization: Bearer <token>. Crie-o no Flowtly, na página de Segurança do seu perfil. Um token atua com as suas próprias permissões, dura 365 dias, salvo se escolher outro prazo (no máximo 730), e pode ser revogado aí a qualquer momento.

Cabeçalho da organização

Cada pedido leva também um cabeçalho instance com o ID da organização em que está a atuar. Sem ele, a API recusa o pedido.

Pedidos e respostas

As respostas são JSON-LD (application/ld+json) ou JSON simples (application/json). As atualizações usam PATCH com application/merge-patch+json. As coleções são paginadas com page e itemsPerPage, com um máximo de 500 itens por página.

Versionamento

A API não tem versões nos seus caminhos nem nos cabeçalhos: os recursos estão na raiz, por exemplo https://api.flowtly.eu/projects. O documento OpenAPI 3.1 é publicado em https://api.flowtly.eu/docs.json.

Limites de frequência

Os pedidos têm um limite de frequência. Os pedidos de escrita (POST, PUT, PATCH, DELETE) contam por organização numa janela de cinco minutos, com um limite mais alto quando a organização está verificada ou subscrita. Ao exceder um limite, a API responde 429 Too Many Requests com um cabeçalho Retry-After que indica os segundos de espera. Os limites podem mudar, por isso leia Retry-After em vez de fixar um número no código.

Descontinuações

Um endpoint ou campo que vai ser retirado aparece marcado como deprecated no documento OpenAPI. A API não envia cabeçalhos de descontinuação, por isso consulte o documento quando atualizar uma integração.

Testar a sua integração

Não existe um ambiente de testes separado. Teste a sua integração num espaço de trabalho de teste com dados de exemplo antes de ligar dados reais. Enquanto a organização não estiver verificada nem subscrita, um teste funciona com um limite de escrita mais baixo e não envia e-mails.

O que mudou

As alterações da API são anunciadas nas notas de versão, juntamente com o resto do produto.

Ler as notas de versão

Projetos & entrega

Projetos, tarefas, membros, taxas e alocações — automatize a entrega e sincronize os dados dos projetos.

Recursos e capacidade

Alocações, o banco de recursos, a janela do cronograma e os valores reais — planeie quem trabalha em quê e consulte o que efetivamente fizeram.

Faturação & pagamentos

Faturas, linhas, pagamentos, lembretes e faturação eletrónica (KSeF) — automatize a faturação de ponta a ponta.

Orçamentos & gastos

159

Orçamentos, transações, custos, impostos e contas bancárias — acompanhe as despesas e reconcilie automaticamente.

CRM — leads e negócios

Leads, negócios, pipelines e fases — conduza o funil de vendas a partir dos seus próprios sistemas.

Clientes & contrapartes

Clientes, contactos e contrapartes — mantenha seu CRM e Flowtly sincronizados.

RH e Pessoas

Colaboradores, departamentos, cargos, benefícios e responsabilidades — automatize os fluxos de dados de RH.

Desempenho e avaliações

Ciclos, modelos, perguntas e sessões de avaliação — realize avaliações de desempenho programaticamente.

Tempo e Assiduidade

Horário de trabalho, licenças, escalas e feriados — registre e leia assiduidade programaticamente.

Recrutamento e ATS

Candidatos, tarefas de recrutamento, entrevistas e agendamento — ligue o seu ATS.

Propriedade e Ativos

Imóveis, reservas, ativos, contadores e leituras — gira dados imobiliários através da API.

Contratos e Conformidade

Acordos, contratos, anexos e planos de pagamento — automatize os fluxos de trabalho contratuais.

Documentos e assinaturas

Documentos, armazenamento e pedidos de assinatura eletrónica — carregue, organize e assine ficheiros.

Customização e Tags

Atributos, conjuntos de atributos, regras e etiquetas — estenda os objetos Flowtly com os seus próprios campos.

Organização & configuração

Organização, localizações, utilizadores, integrações e subscrição — configure o espaço de trabalho.

Utilizadores e acessos

Utilizadores e grupos de permissões — gira quem pode ver e fazer o quê.

Webhooks & auditoria

Webhooks e logs de auditoria — reaja a eventos e rastreie mudanças.

Exportações de contabilidade

Exportações para Wapro, Optima, Enova, Symfonia, MT940 e SEPA — entregue os dados ao seu contabilista.

Servidor MCP

Conecte ferramentas de IA ao Flowtly através do Model Context Protocol em mcp.flowtly.eu.