Conhecendo a plataforma

O primeiro passo é conhecer a plataforma, nela você deverá realizar o cadastro do seu usuário somente no ambiente de Produção, não sendo necessário o cadastro no ambiente de Desenvolvimento, isto porque para a integração iremos fornecer dados já previamente cadastrado para que possa realizar a integração.

Cadastrando o usuário

Acesse a URL de produção e se cadastre na plataforma, clicando na opção Create account.

A plataforma é dividida em cinco menus: Dashboard, Beneficiário, Conta, Webhook e API key

Cadastrando seu primeiro beneficiário

No menu beneficiário realize o cadastro do seu primeiro beneficiário, lembre-se que não é necessário ter duplicidade de beneficiário, isto porque a plataforma te permite você ter inúmeras contas para geração de boletos de diversos bancos com o mesmo cadastro, desde que a chave primário (CPRF) seja única.

*CPRF - Cadastro de pessoa na receita federal, que pode ser Pessoa Física, Jurídica ou até mesmo estrangeiro

API Key

Agora antes de cadastrar um conta para emissão de algum banco é necessário que você tenha cadastrado pelo menos uma API Key e um Webhook de resposta para sua aplicação.

Clique no botão de adicionar uma API Key e digite um nome de identificação para a mesma, lembrando que você pode ter diversas API Key para aplicações diversas.

Após salvar e no botão de Ações você terá as opções:

Copiar token
Atualizar token
Excluir

Webhook

Continuando o cadastro básico e complementando que antes de cadastrar um conta também é necessário definir um Webhook previamente, isto porque como há possibilidade de termos N Webhooks, você pode aplicar os mesmos para Contas diferentes inclusive do mesmo beneficiário, não te limitando a integração para aplicações diversas e um único login na plataforma.

Clique no botão de adicionar um Webhook e indique conforme abaixo:

Nome: Defina o nome que desejar para identificar o seu Webhook
Url: Indique qual será a URL que nossa plataforma vai chamar para lhe devolver as respostas
Token: Indique se na nossa chamada teremos que te devolver algum token de acesso

Cadastrando uma conta

Enfim, após ter feito os cadastros iniciais, chegamos na hora em que podemos sim realizar o cadastro da conta.

As contas são o local onde indicamos todas as informações necessárias para um conjunto de Beneficiário, Banco e Webhook para que ai final seja gerado o UUID da mesma, que também será necessário para toda integração realizada com nossa Super API.

Ao clicar no botão de adicionar uma Conta a primeira informação a ser definida será o Banco para qual será feito o cadastro das informações, veja que a tela é dinâmica e para cada banco será solicitado informações pertinentes a integração com o banco.

Importante: Se o Beneficiário final tiver for emitir boletos em 2 ou mais bancos ou até mesmo com carteiras diferentes para o mesmo banco, será necessário cadastrar uma conta para cada carteira.

Após escolher o Banco e o Webhook preencha as demais informações para criar sua conta e para cada campo e por banco ao clicar no botão de Ajuda informações referente aquele banco estarão disponíveis para auxiliar.

Processo de Sincronização

A sync é feita de forma automatica junto aos bancos, esse processo pode ser melhor observado no fluxo a seguir: