Guia do Desenvolvedor

Bem-vindo ao Portal do Desenvolvedor

 

Registrar-se é muito simples!

 

Nossas APIs foram projetadas para se adaptar às suas necessidades e têm sido bem-sucedidas em múltiplos casos de uso, permitindo oportunidades comerciais inovadoras. Fornecemos documentação clara e simples para facilitar sua integração.

Registro

Novo no Portal?

Crie sua conta clicando no botão de Registro. Comece preenchendo um breve formulário para completar seu perfil de usuário, não se esqueça de revisar osTermos e Condições!

 

Se a sua empresa ainda não foi registrada, você terá a opção de selecionar seu tipo de Entidade. Selecione "Prestador de Soluções" (como uma FinTech ou fornecedor) e preencha os campos com as informações gerais da sua empresa. Por último, forneça informações sobre sua solução. 

Usuário

  • Digite o nome da empresa no campo designado.
  • Selecione a opção: "A empresa não existe, vamos criá-la."

Tipo de Entidade

  • De acordo com seu tipo de entidade, selecione Provedor de soluções e clique em Próximo.

Informações da Empresa

  • Preencha as informações relacionadas à sua entidade nas seções “Informação da Empresa,” “Perfil da Empresa,” and “Informação Adicional.

Informações da Solução

  • Adicione informações sobre o(s) produto(s) que você desenvolveu na seção " Informações sobre a Solução.” 
  • Conte-nos tudo sobre suas soluções! Apenas os campos marcados com um asterisco são obrigatórios, mas sugerimos que você forneça o máximo de informações possível para que todos possam entender melhor o seu produto.

 

A qualquer momento, enquanto preenche os formulários de registro, você pode revisar as informações fornecidas clicando no botão de Voltar. Depois de inserir todas as informações necessárias, clique em Concluir e Carregar Informações.

 

Antes que seu registro seja aprovado, suas informações devem ser revisadas por nossa equipe. Como desenvolvedor, uma vez que você tenha essa autorização de acesso, poderá ter visibilidade sobre as funcionalidades da plataforma de acordo com seu papel, “ENTITY_ADMIN” é o recomendado.

Além disso, agora que está aprovado, o Bankbot atribuiu automaticamente 5 clientes e transações para que você comece a testar sua solução e as APIs.

Nossas APIs

Pronto para integrar em nosso ambiente Sandbox?

Agora que está registrado, você pode começar a testar sua solução!

Na barra lateral, na seção de APIs, você pode encontraras todas, navegar pelo catálogo, consultar as categorias ou até mesmo gerenciar suas APIs. Para começar a usá-las, clique no cartão desejado e selecione “Solicitar Aprovação.” O Administrador do Portal receberá uma notificação e deverá aprovar sua solicitação antes que você possa usar a API, mas você pode continuar consultando a documentação da API.

 

Para começar a usar qualquer API, você deve:

  • Ir para a seção de APIs no menu principal.
  • Selecione o cartão da API e vire-o com um clique
    • Nas guias, você pode encontrar informações sobre ela, como descrição, certificações ou se está integrada com o BankBot.
  • No cartão selecionado, clique em
    • Solicitar Aprovação para informar ao Administrador do Portal que você deseja usar a API, ele precisará aprovar o pedido antes de você poder começar a usá-la.
    • Veja a API para revisar toda a documentação da API, consultar exemplos e erros, ou até mesmo baixar Coleções do Postman para começar a testá-las. Por padrão, você verá a documentação de um ambiente de teste, o do Bankbot. No canto superior direito, você pode escolher qual documentação deseja ver.
  • Depois que sua solicitação for aceita, você receberá um e-mail informando que foi aprovada. Aqui você encontrará instruções para obter a Consumer Key e o Consumer Secret da sua solução, necessários para obter a autorização do 4WRD.
  • Você pode ver o conjunto de APIs aprovadas ou pendentes de aprovação na guia "Minhas APIs" e também encontrar a biblioteca de APIs às quais se inscreveu.

O ID do aplicativo e a chave secreta são credenciais únicas e privadas que permitem à Mastercard identificar seu aplicativo no com segurança, não compartilhe essas informações com pessoas não autorizadas.

 

Para usar qualquer API, você precisará chamar a API de Authorize primeiro, para que possamos reconhecer que você tem acesso à plataforma e que sua solução foi aprovada. Em seguida, vem a API de Create Access Token que usamos para garantir que as credenciais que você está usando como cliente são válidas.

Para se inscrever em outras APIs dentro do catálogo, siga o mesmo processo. Vire o cartão da API com um clique e solicite a aprovação. O consentimento para acessar outras APIs será concedido usando o mesmo ID de aplicativo e Secret Key

Aplicar a uma Necessidade ou Desafio

¡Aceite o desafio!

Outra forma de testar e integrar sua solução é através de uma Necessidade. Algumas delas estão relacionadas a um Desafio, enquanto outras podem ser apenas necessidades específicas e pontos de dor que estão sendo resolvidos. Estas são publicadas pelo Administrador do Portal ou por uma Instituição Financeira específica. Você encontrará uma descrição com informações sobre o que estão procurando e as APIs recomendadas para você considerar. 

Na barra lateral do menu, procure a seção de Necessidades section. Lá você poderá ver todas as necessidades publicadas em seu portal. Vá, explore e encontre algo que pareça interessante para você e sua empresa, ou que você ache que seria adequado para a sua solução. 

Assim que o fizer, você só precisará se inscrever!

Depois de encontrar uma Necessidade que chame sua atenção,

  • Clique no cartão para virá-lo 
  • Em “Mais informações,” você encontrará uma visão geral desta Necessidade, os requisitos, as APIs recomendadas e uma seção para verificar sua aplicação.
  • Clique em "Aplicar para resolver a necessidade" no cartão ou no canto superior direito das informações da Necessidade’s e preencha o formulário de solicitação.
    • Sua solicitação será revisada pela instituição financeira que publicou essa necessidade/desafio, se eles acharem que sua solicitação se adequa ao que estão procurando, você receberá uma notificação por e-mail.
    • Uma segunda aprovação da equipe da instituição financeira é necessária antes que você possa começar a testar sua solução.

Assim que sua inscrição for Aprovada para Sandbox, você será automaticamente inscrito nas APIs recomendadas para a Necessidade. Você pode verificar as APIs às quais está inscrito na guia de “Minhas APIs”. Agora você pode começar a construir.

Você pode começar a testar ou desenvolver sua solução para essa Necessidade, específica, testando-a contra o Bankbot ou o núcleo da Instituição Financeira. Não se esqueça de que você terá que apresentar um protótipo para isso dentro de sua aplicação para testá-lo e decidir se é o que estão procurando.

Best of luck!

Comece a Testar com uma Coleção do Postman.

Aquecendo!

Depois de ter se inscrito com sucesso em um conjunto selecionado de APIs ou ter sido aprovado para uma Necessidade, você está pronto para começar a testar com uma coleção do Postman. Fornecemos algumas coleções do Postman separadas por grupos de APIs, casos de uso ou até mesmo por instituição, para que você possa escolher a que mais lhe convier. Escolha uma, baixe-a, revise a documentação como guia e comece a testar!

 

Para começar a fazer testes, você precisa:

  • Ir para APIs no menu principal
  • Selecionar o cartão da API e clicar nele para virar 
  • No cartão selecionado, clique em Veja a API
  • Ir para Overview e na parte superior direita você pode selecionar a coleção do Postman da instituição que está procurando 
  • Clicar no botão de download para obter sua coleção do Postman
  • Importá-la para o Postman assim que você a tiver baixado
  • Clicar na coleção, ir para as variáveis e alterar a key & secret que foi fornecida para a sua solução.
    • Para obtê-las, vá para Serviços> Inscrições no Gateway, selecione sua solução e obtenha a Consumer Key e Secret.
  • A instituição deve fornecer a você um nome de usuário e uma senha  para o “cliente” ou conta com a qual você irá fazer o teste
  • Certifique-se de que a variável do provedor corresponda à instituição à qual você está tentando se integrar. 
    • Se não tiver certeza de ter essa variável corretamente, sempre pode entrar em contato com o administrador do portal. 
  • Uma vez que tiver todas as variáveis configuradas corretamente, você pode começar a fazer testes. Execute a API Authorize para gerar a aplicação, a sua solução e o token de acesso.
  • A seguir, execute a Create Access Token para gerar o token de acesso do cliente que foi fornecido pela sua instituição
  • Agora você pode executar qualquer API que selecionar.

 

Se você tiver algum problema ou dúvida em relação à coleção do Postman ou à documentação, não hesite em entrar em contato conosco em sandboxasaservice@mastercard.com.

Faça uma chamada à API

Comece a testar!

Agora vem a parte divertida! Comece a construir com o BankBot, nosso simulador de dados bancários.

No momento da integração, recomendamos que você siga a documentação das APIs e faça uma chamada através do HTTPS para uma API autorizada. A plataforma suporta autenticação do cliente OAuth2 para gerar um token de acceso que será válido por tempo limitado. Esse token de acesso permite que você faça uma chamada, como uma transferência ou consulta de conta. Assim que o token de acesso expirar, você terá que solicitá-lo novamente.

Para começar a integrar, você deve verificar que informações estão disponíveis para teste. Para isso, você pode usar o nosso Bankbot.

No menu principal, vá para o simulador Bankbot. Aqui você pode encontrar dados sintéticos de Clientes e Transações.Em "Clientes", você encontrará conjuntos de dados "fictícios" fornecidos pela instituição a que está inscrito, e em "Transações", você poderá encontrar as diferentes operações correspondentes aos "Clientes" criados. Os conjuntos de dados podem ser filtrados pelo tipo de transação, como pagamentos, depósitos ou transferências. Considere o Bankbot como um banco real onde você pode testar sua solução por meio de nossas APIs sem precisar passar por integrações reais e sem qualquer repercussão se algo acontecer.

 

Nossa documentação da API mostrará como formatar as chamadas HTTPS. Preencha as informações necessárias e você poderá iniciar o processo de construção de sua aplicação em um ambiente controlado.

 

Se você não consegue encontrar as informações sobre clientes ou transações que precisa para testar sua solução ou tem dúvidas sobre nossa documentação, deixe-nos saber! Você pode abrir um Ticket, ir para Serviços > Tickets e perguntar o que precisar ou entrar em contato conosco por e-mail.

Reveja as Transações sob "Métricas"

Monitore suas chamadas de API

Para garantir que você e a instituição financeira possam visualizar as chamadas de API, fornecemos Métricas para que possam revisar suas chamadas de API. 

No menu da barra lateral, clique em Métricas. O Simulador mostra as transações com o Bankbot, o Sandbox mostrará suas chamadas de API assim que estiver integrado ao núcleo da instituição em um ambiente de testes, e a Produção mostrará as chamadas reais de API com o núcleo da instituição.

Em Métricas, você poderá filtrar por “API,” “Serviços,” “Solução,” ou “Intervalo de datas,”  dependendo do que deseja ver, você pode filtrar ainda mais por um período de tempo específico, ou seja, por, ano ou por by Mês. As soluções mais ativas também serão exibidas. Por fim, mas não menos importante, em um gráfico, você também pode comparar todas as suas chamadas de API, tanto as realizadas com sucesso quanto as falhas.

Quando terminar a etapa de testes com o Bankbot e no Sandbox, nossa equipe fornecerá todo o suporte necessário para levar o aplicativo para produção. 

 

Lembre-se de que estamos aqui para ajudá-lo em tudo o que pudermos!

Começar a transacionar com o Core de uma Instituição Financeira

Agora você está pronto para se conectar ao Core de um Banco!

Depois de testar sua solução com o Bankbot e ter certeza de que as APIs funcionam corretamente, você pode solicitar a integração ao Core de um banco. Ou talvez uma instituição financeira tenha visto sua Solução, revisado seu perfil, verificado suas chamadas à API nas Métricas, e decidiu entrar em contato com você porque gostou do que viu! 

Seja qual for o caso, você está pronto para se integrar a um verdadeiro Core, sem mais Bankbot. Para isso, há duas opções, como mencionado anteriormente.

Se você deseja se integrar ao Core e solicitar por conta própria, siga estas etapas:

  • Clique em APIs no menu principal da barra lateral
  • Ir para Minhas APIs e selecione o cartão da API à qual deseja solicitar acesso
  • Depois de virar o cartão, clique em Core Banking Selection
  • Selecione a Instituição Financeira à qual deseja se integrar
    • Aqui, você pode ter várias opções para selecionar, poderá ver a qual Core você já está aprovado, pendente de aprovação ou disponível para solicitar acesso.
    • Depois de escolher o Core, a Instituição Financeira receberá um e-mail para aprovar ou rejeitar a solicitação.
  • Você será notificado sobre como obter um código de provedo para o Core da Instituição Financeira.
    • APIs > Minhas APIs Clique no cartão da API à qual solicitou acesso e selecione o Core ao qual deseja se integrar, o código está na parte de trás do cartão

A outra opção é se o Portal Owner lhe der acesso direto ao Core. Como mencionado anteriormente, se já revisaram sua Solução e querem que você se integre ao seu Core, eles podem lhe conceder acesso a ele. Você receberá uma notificação sobre como obtê-lo e poderá obter o código do Provedor/Entidade assim que for aprovado para usá-lo como variável para sua integração.

Não se esqueça de que as APIs e a documentação podem ser diferentes para o Bankbot em comparação com a Instituição Financeira à qual está tentando se integrar. Sempre verifique a documentação e, se tiver alguma dúvida, lembre-se de que seu Portal Owner e Mastercard estão aqui para ajudá-lo!

Boa sorte na integração! Esperamos que este guia tenha sido útil para você. 

Você ainda está perdido e precisa de mais ajuda?

Você precisa de mais informações? Por favor, solicite o nosso Manual do Fornecedor de Soluções para guiá-lo através da plataforma de Mastercard.

Ajuda