API marketplace

A plataforma da Dock permite que o emissor conecte seu aplicativo às nossas APIs através da API marketplace. Estas APIs permitem que o emissor faça a compra de bens e serviços e que os disponibilize do modo que desejar aos seus portadores.

Além de permitir que o emissor utilize a nossa solução de integração de API para desenvolver um marketplace para seus portadores há outras possibilidades de uso, como a utilização dos vouchers para "member get member", onde emissores podem oferecer vouchers como prêmio para portadores que o indicarem para outros membros.

A API permite total liberdade para que o emissor seja responsável por customizar uma solução.


Funcionamento da API marketplace

Existem dois fluxos distintos: um para a emissão de vouchers/gift cards e outro para recargas de celular. Como se trata de uma solução em APIs, o emissor poderá criar soluções de acordo com as suas necessidades, mas um fluxo base para uma compra está mostrado a seguir:

Voucher / gift card:

1- O portador se direciona a uma página onde vê os serviços disponíveis;
2- O portador seleciona um serviço e vê quais valores este serviço oferece;
3- O portador seleciona um valor e segue o processo de autenticação da aplicação do emissor;
4- O pagamento é confirmado e o portador recebe o voucher.

Recarga de celular:

1- O portador seleciona a operadora onde fará a recarga;
2- O portador informa o número de celular a ser recarregado;
3- O portador seleciona um dos valores disponíveis e segue o processo de autenticação da aplicação do emissor;
4- A recarga é realizada e o portador recebe o valor.


Integração com a API marketplace

Emissão de voucher / gift card

1- O emissor pode buscar por todos os serviços disponíveis através do endpoint consultar comerciantes;

2- Ao selecionar um dos serviços disponíveis a transação é iniciada;

3- Os valores disponíveis para aquele serviço podem ser retornados através do endpoint criar uma nova transação de compra de voucher;

4- O pedido pode ser cancelado antes da confirmação através do endpoint cancelar uma transação de voucher ou então confirmado, utilizando o valor selecionado para a compra através do endpoint confirmar uma transação de voucher.

📘

Nota

Para alguns serviços específicos é obrigatório informar e-mail e CPF do portador que faz a compra.

Manutenção de voucher / gift card


Emissão de recarga de celular

1- O emissor pode buscar por todos os serviços disponíveis através do endpoint consultar comerciantes;

2- A transação é então iniciada, selecionando um dos serviços disponíveis e informando um número do telefone a ser recarregado através do endpoint criar uma nova transação de recarga;

3- A transação pode ser cancelada através do endpoint cancelar uma transação de recarga ou confirmada através do endpoint confirmar uma transação de recarga;

Manutenção de recarga de celular

🚧

Atenção

Recargas de celular não possuem reversão, pois assim que a compra é confirmada o valor é disponibilizado para o número informado.


Setup da API marketplace

1- O emissor que tiver interesse na feature deve entrar em contato com o seu gerente de contas comercial.
2- O emissor é o responsável pelo desenvolvimento da solução que consumirá nossas APIs e precisará de uma equipe de backend e proceder com a integração.
3- O emissor deverá disponibilizar para a Dock um material que demonstre como será a experiência e os fluxos que serão oferecidos dentro de seu aplicativo, para que sejam validados junto aos fornecedores.


Did this page help you?