Integrando na Bcodex

Olá, bem-vindo à documentação técnica da Bcodex!

Nessa documentação, você vai encontrar todas as informações necessárias para integrar com as nossas APIs.

Sandbox e Produção compartilham o mesmo código, mas estão isolados um do outro, pois estão sendo executados em servidores separados e acessam bancos de dados diferentes. Mudar para Produção exige que você altere apenas a URL base e as credenciais. Os SDKs selecionam a URL base de acordo com o ambiente que você escolhe.

Postman:

Para facilitar a sua integração, disponibilizamos uma collection no Postman com todos os endPoints do produto Pix Pay.

Processo de Integração

Para se integrar na API Bcodex, você precisa passar por quatro etapas:

1. Obtenha suas credenciais de acesso

Nossas APIs possuem autenticação, utilizando SSO.

Nossos parceiros receberão por e-mail as credenciais necessárias para a autenticação no ambiente sandbox. Essas credenciais incluem o username e o password.

Com essas informações em mãos, nossos parceiros terão acesso a todas as funcionalidades disponíveis. Certifiquem-se de inserir essas credenciais de autenticação em todas as rotas relevantes.

Credenciais de Sandbox

Para acessar os endpoints em ambiente de sandbox, utilize as seguintes URL base:

Pix Pay: https://sandbox.bcodex.io/

Para obter suas credenciais, basta solicitá-las ao nosso suporte@bcodex.io informando o seu CNPJ, Nome da companhia, Nome fantasia, e a chave pix relacionada ao CNPJ informado.

Credenciais de Admin: São credenciais específicas destinadas à autenticação de um admin e à sua utilização nos endpoints designados exclusivamente para o admin.

Credenciais de Managers: São credenciais específicas destinadas à autenticação de um manager e à sua utilização nos endpoints designados exclusivamente para um manager.

No título de cada pasta de endpoints, indica qual autenticação deve ser utilizada para acessar o respectivo endpoint.

2. Integração

Nessa fase nosso cliente pode realizar seus desenvolvimento em nosso ambiente de sandbox (testes), onde é possível testar toda a comunicação com nossas apis e entender seus comportamentos.

3. Homologação

Após finalizar o desenvolvimento com as apis da Bcodex, você deverá preencher um roteiro de homologação da funcionalidade que está implementando, para que possamos validar sua integração.

4. Produção

Ao final da homologação, você receberá o nosso OK e as chaves do seu ambiente produtivo para iniciar sua operação.