Passar para o conteúdo principal

API & Webhook

Escrito por Fin
Atualizado há mais de 3 meses

O API & Webhook é uma extensão do FlyERP que permite a integração segura do sistema com aplicações externas, possibilitando a consulta, envio e automação de dados diretamente via API REST.

Essa extensão é ideal para empresas que desejam integrar o FlyERP com:

  • Sistemas próprios

  • Plataformas de terceiros

  • Aplicações mobile

  • Integrações financeiras, comerciais ou operacionais


🔐 Como funciona a autenticação

O acesso à API do FlyERP é realizado por meio de Bearer Token.

Pontos importantes:

  • Cada filial do FlyERP possui seu próprio token de autenticação

  • O token deve ser enviado em todas as requisições

  • Sem o token, a API não autoriza o acesso


🧭 Como assinar a extensão API & Webhook

Para gerar o token de integração, siga os passos abaixo:

  1. Acesse o FlyERP com seu usuário

  2. Vá até o menu:
    Configurações > Aplicativos e extensões

  3. Localize o aplicativo API & Webhook

  4. Clique para assinar/ativar a extensão

  5. Após a ativação, o sistema irá gerar automaticamente um token

  6. Copie e armazene esse token com segurança

⚠️ Importante:
Caso sua empresa possua mais de uma filial, será necessário gerar e utilizar o token específico de cada filial nas integrações.


🔑 Como enviar o token nas requisições

O token deve ser enviado no header Authorization, utilizando o padrão Bearer Token.

Exemplo de header:

Authorization: Bearer SEU_TOKEN_AQUI

Sem esse header, a API retornará erro de autenticação.


🌐 Documentação oficial da API

Todos os endpoints disponíveis, parâmetros, exemplos de requisição e retorno estão documentados no Postman:

👉 Acesse a documentação oficial da API FlyERP:
https://documenter.getpostman.com/view/24704188/2s8Yt1r8wu#intro

Na documentação você encontrará:

  • Lista completa de endpoints

  • Métodos disponíveis (GET, POST, etc.)

  • Estrutura dos parâmetros

  • Exemplos de respostas

  • Padrão de retorno de sucesso e erro


🔄 Webhooks (quando aplicável)

Além das requisições ativas via API, a extensão também possibilita o uso de Webhooks, permitindo que o FlyERP notifique sistemas externos automaticamente quando determinados eventos ocorrerem (ex.: atualizações financeiras, mudanças de status, etc.).

A disponibilidade e os eventos de webhook podem variar conforme a configuração e os módulos utilizados.


🔒 Boas práticas de segurança

  • Nunca compartilhe seu token publicamente

  • Não versionar tokens em repositórios públicos

  • Utilize HTTPS em todas as integrações

  • Caso suspeite de uso indevido, gere um novo token imediatamente

Respondeu à sua pergunta?