> ## Documentation Index
> Fetch the complete documentation index at: https://docs.procfy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Sobre a API do Procfy

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.

Para acessar a documentação técnica completa da API, consulte: [API Documentação completa](/introducao-api-documentacao).

***

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

Esses recursos permitem que aplicações externas realizem consultas, cadastros, atualizações e sincronizações de dados entre sistemas.

***

## 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:

```plaintext theme={null}
Authorization: Bearer SEU_TOKEN
```

Os tokens possuem 64 caracteres e podem ser configurados com diferentes níveis de acesso de acordo com a necessidade da integração.

***

## Criando um Token de API

Para gerar um novo token:

<Card title="Aviso importante" type="warning">
  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](https://api.whatsapp.com/send?phone=5546999410460).
</Card>

1. Habilite a ativação do Token com o suporte da Procfy;
2. Após ativação, acesse o menu do **Perfil do usuário→Configurações da Conta;**
3. Selecione **Tokens da API**;
4. Clique em **Adicionar**;
5. Informe um nome para o token;
6. Defina uma descrição (opcional);
7. Configure a duração do token;
8. Clique em **Criar API Token**.
9. Copie as requests deste link [https://www.postman.com/procfy-io/procfy/](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:

1. Criar um Token de API;
2. Importar a coleção do Postman;
3. Configurar o Bearer Token;
4. Executar as requisições de teste;
5. 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 |

Em caso de erro, a resposta contém informações detalhadas para auxiliar na identificação e correção do problema.

***

## 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

Cada seção apresenta exemplos de requisições, parâmetros aceitos e exemplos de resposta para facilitar o desenvolvimento das integrações.

Para acessar a documentação técnica completa da API, consulte: [API Documentação completa](/introducao-api-documentacao).