Introdução
A API do Procfy permite integrar sistemas externos à plataforma, possibilitando a consulta, criação e atualização de informações financeiras de forma segura e automatizada. Por meio da API, desenvolvedores podem conectar ERPs, sistemas próprios, aplicativos, plataformas de automação e outras soluções ao ambiente Procfy, eliminando processos manuais e garantindo maior produtividade nas operações financeiras. A API segue o padrão REST e utiliza autenticação baseada em tokens de acesso.O que é possível fazer com a API?
A API do Procfy disponibiliza recursos para integração com os principais módulos da plataforma, incluindo:- Transações financeiras;
- Contas bancárias;
- Contatos;
- Categorias;
- Centros de custo;
- Usuários;
- Anexos de transações;
- Detalhamento de valores.
Como funciona a autenticação?
Todas as requisições realizadas para a API do Procfy devem ser autenticadas utilizando um Token de API. Cada token é exclusivo para uma conta e possui permissões específicas que determinam quais recursos podem ser acessados. Apenas administradores da conta podem criar e gerenciar tokens de acesso. O token deve ser enviado no cabeçalho HTTP utilizando o padrão Bearer:Criando um Token de API
Para gerar um novo token:Informação importante O acesso à API não é liberado automaticamente. Para começar a utilizá-la, é necessário primeiro entrar em contato com o nosso time de atendimento para solicitar a liberação do recurso na sua conta. Chame nosso atendimento via WhatsApp.
- Acesse o menu Configurações da Conta;
- Selecione Tokens da API;
- Clique em Adicionar;
- Informe um nome para o token;
- Defina uma descrição (opcional);
- Configure a duração do token;
- Clique em Criar API Token.
- Copie as requests deste link https://www.postman.com/procfy-io/procfy/ para executar sua primeiras chamadas.
Testando a API
A maneira mais simples de iniciar uma integração é utilizando o Postman. A documentação oficial disponibiliza uma coleção pronta para importação, permitindo testar rapidamente os endpoints disponíveis, configurar autenticação e validar respostas da API. Fluxo recomendado:- Criar um Token de API;
- Importar a coleção do Postman;
- Configurar o Bearer Token;
- Executar as requisições de teste;
- Validar os retornos e integrar ao seu sistema.
Padrões de Resposta
A API do Procfy utiliza respostas em formato JSON e códigos HTTP padronizados para indicar sucesso ou falha das operações. Alguns códigos frequentemente utilizados são:| Código | Significado |
|---|---|
| 200 | Operação realizada com sucesso |
| 400 | Requisição inválida |
| 401 | Token inválido |
| 403 | Token expirado ou sem permissão |
Casos de Uso Comuns
A API do Procfy é frequentemente utilizada para:Sincronização Financeira
Enviar automaticamente receitas, despesas e movimentações financeiras para o Procfy.Integração com Sistemas Próprios
Conectar ERPs, CRMs, aplicativos e plataformas internas à gestão financeira.Automação de Processos
Reduzir lançamentos manuais através da criação automática de transações, contatos e centros de custo.Consolidação de Informações
Centralizar dados financeiros provenientes de múltiplas fontes em uma única plataforma.Segurança e Boas Práticas
Para garantir a segurança das integrações:- Nunca compartilhe seus Tokens de API;
- Utilize apenas conexões HTTPS;
- Revogue tokens que não estejam mais em uso;
- Crie tokens específicos para cada integração;
- Utilize permissões mínimas necessárias para cada aplicação.
Próximos Passos
Agora que você conhece os conceitos básicos da API Procfy, recomendamos seguir para os tópicos específicos da documentação:- Autenticação
- Paginação
- Transações
- Contas Bancárias
- Contatos
- Categorias
- Centros de Custo
- Usuários