Primeiros passos com a API da Mundipagg
Não, o objetivo deste post não é fazer propaganda. Utilizo as soluções da Mundipagg em diversos conteúdos que crio e compartilho com a comunidade (sempre em ambiente de teste, e que qualquer um pode, de forma gratuita, replicar), esse passo-a-passo servirá principalmente para que os outros conteúdos apontem pra cá, facilitando a explicação e centralizando também o conteúdo, que se por ventura tiver atualização no “como fazer”, preciso atualizar apenas em um lugar.
Nesse post basicamente falaremos sobre os seguintes tópicos:
- Breve resumo das funcionalidades;
- Como se cadastrar;
- Como obter sua chave secreta para transacionar;
- Como criar e assinar webhooks;
- Onde achar mais informações, documentação, SDKs, simuladores etc;
Vamos lá? 😄
O que são, onde vivem, do que se alimentam?
Primeiramente, para algumas pessoas que cairam aqui de parequedas, o que seria a Mundipagg? Bom, em resumo, a Mundipagg é uma empresa que oferece soluções de pagamentos no mundo digital, normalmente para e-commerces. A API é bem completa e tem diversos recursos pra permitir que o seu negócio seja mais fluído, por exemplo:
- Uma grande variedade de métodos de pagamentos (cartão de crédito, cartão de débito, voucher, boleto, transferência bancária, entre outros), integrações com diversas plataformas (Vtex, Magento, Oracle Commerce Cloud, Shopify etc) e também de integrações com bancos, adquirentes, bandeiras, provedores de antifraude etc.
- Você consegue processar um único pedido com multiplos meios de pagamento (vários cartões, boletos etc) e com multiplos compradores distintos;
- Retentativa — Quando um pagamento é negado pela adquirente é possível retentar para recuperar a venda e aumentar a conversão. Pode acontecer de forma síncrona (online) com o resultado final no response, ou, assíncrona (offline) onde é retornado o status pendente e depois (após minutos, horas ou dias — configurável) enviado um webhook com o status final. Pode-se retentar na mesma ou em adquirentes diferentes;
- Uma lógica flexível e avançada para gestão de assinaturas, faturas, planos, precificação etc;
- Wallet de clientes e cartões, com possibilidade de renovação automática e compartilhamento entre lojas, além da importação de cartões de outras soluções de mercado;
- Gestão de marketplaces e split de pagamentos com informações de recebedores, contas bancárias e transferência;
- Opções de checkout em diversos formatos, como redirect, envio automático por e-mail e checkout transparente (tokenização de cartão em ambiente seguro via javascript);
- Um sistema completo de notificação através de webhooks com tudo que acontece dentro do sistema divido em eventos específicos e claros;
- Possui SDK para facilitar a integração com as principais linguagens de programação, como PHP, Python, .NET, Java, Ruby etc;
- O ambiente de testes (sandbox) possui simuladores e regras para permitir que você reproduza cenários do dia-a-dia com facilidade, como simular compras pagas, com falha, cancelamentos, até mesmo forçando uma simulação de timeout na API;
- A Mundipagg é um empresa PCI DSS 3.2, o que garante toda a segurança de operações financeiras e proteção dos dados em tudo que ocorre em seu ambiente;
- Técnicamente falando, a API tem um contrato bem charmoso e para os amantes do RESTful, será de fácil entendimento, integração e implantação.
Como se cadastrar para testar a API e todas as funcionalidades?
O passo-a-passo abaixo, vai exibir o fluxo de cadastro, como obter a sua chave para utilizar a nossa API e como cadastrar webhooks.
Primeiramente, acesse o nosso dashboard https://dash.mundipagg.com.
Na listagem você poderá clicar na sua conta para ser direcionado para o dashboard transacional , onde você poderá acessar os dados da sua conta de teste. O status inativo significa que sua loja não está habilitada para o ambiente de produção, o que para testes não é um problema.
Bom, nesse ponto você já tem uma chave para transacionar na sua conta de teste da Mundipagg. Essa chave é utilizada nos endpoints da API com Basic Auth, onde o usuário é a chave secreta e a senha deve ficar vazia.
Um primeiro teste para saber se está tudo ok, pode ser feito via postman ou usando o seu terminal com o comando curl:
Substituindo a sk_xxxx pela sua chave secreta, você irá criar um pedido na Mundipagg com sucesso. A resposta será algo como:
O pedido poderá ser visualizado no dashboard transacional da Mundipagg:
Webhooks
Na criação de um pedido, vários eventos acontecem e são lançados. Por exemplo, logo que o pedido é criado, ele dispara um evento order.created informando que um pedido foi criado. Se o comprador informador for um novo comprador, também será emitido um evento de customer.created. Tão logo quando o pedido for autorizado e capturado, order.paid. Caso seja cancelado, order.canceled.
Esses eventos são gatilhos para o envio de webhooks, basicamente uma requisição com o tipo de evento e conteúdo atualizado referente ao evento, enviado para uma URL que você pode cadastrar e assinar para uma ou mais URLs e tipos de eventos, via dashboard.
São dezenas e dezenas de webhooks, tornando bastante flexível a interação assíncrona do seu sistema com as atualizações que ocorrem em geral na Mundipagg, de maneira totalmente passiva, sem necessidade de técnicas de pulling e afins.
Documentação
A documentação de negócio, que explica mais conceitual sobre os recursos oferecidos pode ser encontrado nessa URL: https://docs.mundipagg.com/docs
Para acessar o API Reference, acesse: https://docs.mundipagg.com/v1/reference
Lembre-se, a URL base da API é: https://api.mundipagg.com/core/v1, seja para o ambiente de Produção ou Sandbox. O que diferencia sua operação é a sua chave (sk_xxxx vs sk_test_xxxx).
SDKs
Para facilitar sua integração, você pode utilizar as SDKs, disponíveis para as principais linguagens.
- C# / .NET
- PHP
- Ruby
- Python
- NodeJS
- Go
- Java
Você pode achar mais informações sobre as SDKs nas docs ou diretamente no github da Mundipagg.
Aproveita e dá uma olhadinha nos outros projetos, além das SDKs, você pode encontrar projetos opensource, como a API de boletos, API de simulação e Mock etc.
Simuladores
O simulador é um conjuntos de regras que possibilita a execução de distintas respostas baseadas em alguma informação passada enviadas na requisição, como por exemplo, se eu quero criar um pedido com cartão de crédito e quero que o pedido seja “pago”, eu posso usar a regra de informar o número do cartão com o valor “40000000000010' que o sistema entenderá. Caso eu envio o número “4000000000000028”, o pedido voltará com falha, vide regras do simulador.
Para entender mais sobre as regras que os simuladores da Mundipagg utilizam, verifique os links abaixo:
O objetivo desse artigo é explicar um pouco sobre a API da Mundipagg e como criar uma conta de teste para fazer alguns demos que uso em palestras, artigos etc. Mas, caso goste de testar e brincar com ela, leve-a também para suportar sua operação em produção, além dos testes. Toda a tecnologia da Mundipagg é bem bacana, com ótimos recursos pro seu negócio e com a segurança, disponibilidade e performance que um software de pagamentos precisa e que hoje suportar praticamente a metade de todo e-commerce brasileiro.
Até o próximo post pessoal! 😃
