Módulos associados

1. Redes de Venda > Gestão das Redes

2. Gestão da Rede de Venda

Versão

BDOS • 6.22.110

Após definir a senha, o acesso deve ser realizado no mesmo domínio do BDOS da operação.

Nesse momento, o acesso não deve ser feito utilizando o e-mail e a senha do gestor da operação.

Utilize:

• E-mail: e-mail cadastrado na Rede de Venda;

• Senha: senha definida pela Rede de Venda.

Após o login, o usuário será direcionado ao ambiente de Gestão da Rede de Venda.

Como a Rede foi configurada com o tipo Token, será disponibilizado o módulo: Integração por API

A primeira etapa do onboarding é a formalização do contrato para utilização da API Pública da Bilhetagem Digital.

Para concluir essa etapa:

1. Leia o contrato disponibilizado no portal.

2. Baixe a versão do contrato sem assinatura.

3. Realize a assinatura do documento.

4. Anexe no portal a versão do contrato já assinada.

5. Envie o documento para validação.

Após o envio e a conclusão dessa etapa, será disponibilizada a opção de pagamento do serviço.

Com o contrato enviado, a próxima etapa é realizar o pagamento do Setup da API.

O pagamento é realizado diretamente pelo portal, conforme as opções disponibilizadas no fluxo.

Após a confirmação do pagamento, o sistema libera as funcionalidades necessárias para continuidade da configuração.

Entre elas estão:

• A configuração da API;

• A documentação e os endpoints;

• O acesso às credenciais;

• A gestão da mensalidade e dos Tokens.

Após a confirmação do pagamento do Setup, acesse novamente:

Integração por API → API

Nessa etapa estarão disponíveis a documentação e os endpoints da API Pública da Bilhetagem Digital.

A tela disponibiliza:

• Open API Spec: acesso à documentação e aos endpoints da API.

• Baixar Credenciais: permite obter as credenciais necessárias para realizar a integração.

As credenciais são liberadas automaticamente após a conclusão das etapas anteriores do onboarding.

Após a liberação da API, a Rede de Venda também terá acesso à aba:

Integração por API → Tokens e Mensalidade

Nessa área é possível acompanhar o consumo de Tokens e realizar a gestão dos pagamentos relacionados à utilização da API.

A mensalidade inclui uma quantidade determinada de Tokens Inclusos. Caso seja necessário utilizar uma quantidade superior ao limite mensal, a Rede de Venda poderá adquirir Tokens Extras.

Os Tokens possuem validade de 30 dias e são consumidos em regime FIFO (First In, First Out). Dessa forma, os Tokens adquiridos primeiro são consumidos antes dos Tokens adquiridos posteriormente.

A mensalidade da API pode ser paga por Pix ou Pix Automático, conforme a modalidade escolhida pela Rede de Venda.

Na opção de Pix Automático, a cobrança é realizada automaticamente a cada ciclo de mensalidade.

Na aba Tokens e Mensalidade, também ficam disponíveis as informações relacionadas ao ciclo atual, à próxima cobrança e à modalidade de pagamento contratada.

A aba Tokens e Mensalidade apresenta os indicadores relacionados ao uso dos Tokens, permitindo acompanhar:

• Tokens utilizados;

• Tokens disponibilizados na mensalidade;

• Tokens Extras adquiridos.

O consumo segue o regime FIFO e os Tokens não utilizados não são acumulados para o ciclo seguinte. Ao final do período de validade, os Tokens não utilizados expiram.