Primeiros Passos

Bem-vindo aos Primeiros Passos da documentação! Aqui você vai encontrar as orientações necessárias para começar a usar nossa API e integrar nossas soluções ao seu sistema com facilidade.

Nossa API foi projetada para ser intuitiva e eficiente, permitindo que você conecte seus sistemas às funcionalidades de pagamento e conciliação da Enoq rapidamente.

Passo 1: Escolha a funcionalidade desejada

A Enoq oferece uma série de funcionalidade para atender diferentes necessidades. Antes de começar, escolha a API que melhor se adapta ao seu caso de uso:

• Plataforma de Conciliação Web: Plataforma Web que oferece uma experiência visual e intuitiva para gerenciar suas transações.
• API de Conciliação: Ideal para integrar funcionalidades de análise e reconciliação de pagamentos.
• API de Emissão de Boletos: Perfeita para quem precisa emitir e gerenciar boletos bancários.
• API de Gateway de Pagamentos: Use para processar transações com cartões de crédito e débito de forma rápida e segura.

Cada API possui documentação específica, que você pode acessar no menu lateral.

Passo 2: Realize a autenticação

Para acesso a plataforma de conciliação web, acesse https://ib.enoqbank.com/.

Para consumir qualquer uma de nossas funcionalidades via API siga os passos indicados abaixo:

• Obtenha o userName e password repassando os dados necessários para nossa equipe (CNPJ, razão social, contato técnico e IP do servidor).
• Faça login com POST /api/authentication/login, enviando userName e password.
• Receba o token de autenticação no campo accessToken.
• Inclua o token no header Authorization para usar outros endpoints.
• Renove o token antes de sua expiração.

Para mais detalhes, consulte a seção de Autenticação.

Passo 3: Comece a usar

Agora que você já escolheu a API e configurou sua autenticação, é hora de integrar as funcionalidades ao seu sistema:

1. Consulte os endpoints disponíveis na documentação específica da API escolhida.
2. Realize chamadas de teste utilizando ferramentas como Postman ou cURL.
3. Integre os endpoints ao seu sistema, seguindo os exemplos práticos e boas práticas indicados.

Pronto! Com esses passos, você já pode começar a usar as APIs da Enoq e aproveitar todas as vantagens de nossas soluções.

Se precisar de ajuda, nossa equipe está à disposição. Explore a documentação para mais informações e boa integração!