Guia de Uso

Introdução

Este guia visa o entendimento de como o sistema autorizador de uma instituição financeira pode interagir com o sistema transacional da Saque e Pague por meio de APIs. Qualquer cliente que tenha interesse em ser parceiro da Saque e Pague, pode fazer uma conta e começar a usar a plataforma para desenvolver as soluções desejadas.

Esta plataforma foca no desenvolvimento e testes das duas integrações principais que ocorrem via API. Aqui o desenvolvedor do parceiro possui em mãos a documentação e SDKs necessários para facilitar seu processo de integração com a Saque e Pague.

O processo inicial para utilização da plataforma passa por cinco etapas, listadas abaixo:

O parceiro cria um aplicativo com um endereço que possa ser alcançado externamente pela plataforma Saque e Pague. Em seguida, ele pode fazer o download de uma das SDKs disponíveis, a fim de auxiliar na implementação do serviço de autorização. Quando alguma operação da API for desenvolvida, ela já pode ser testada por meio da plataforma. Assim que todas as operações de interesse estiverem funcionando como desejado, o cliente já estará preparado para entrar em contato com a Saque e Paguee firmar um acordo de parceria para transacionar via os canais da rede Saque e Pague.

Pré-requisitos

Antes de iniciar o processo de integração, o cliente precisa se informar sobre as três partes principais que devem ser implementadas e testadas. As integrações são definidas e detalhadas no tópico de integrações. Lá o cliente poderá tirar dúvidas sobre as regras de negócio e fluxo das operações que compõem o conjunto de transações financeiras disponíveis para integração.

Este portal, no entanto, foca no desenvolvimento e testes das duas integrações por API. Aqui o desenvolvedor é servido de documentação e SDKs para que agilize seu processo o máximo possível.

App

Tendo noção de como o sistema funciona, o parceiro deve se cadastrar no site e criar uma App. Além do nome e descrição, deve-se informar o endereço do serviço da API Transacional a ser testada e selecionar esta API na lista para que a mesma seja vinculada ao testes da plataforma. Este endereço será usado somente para os testes feitos pelo parceiro por meio do portal, pegando suas requisições de teste e as mandando para o endpoint configurado.

Download de SDK

A Saque e Paguefornece, para as duas integrações por API, algumas soluções parciais das aplicações necessárias. Tais soluções foram geradas nas linguagens Java, .NET e NodeJs. Caso o cliente já trabalhe com estas linguagens, ele terá a chance de ter seu processo acelerado pelas SDKs fornecidas, restando o desenvolvimento das regras de negócio internas de sua empresa.

Desenvolvimento

O cliente pode escolher como desenvolver as suas aplicações com as APIs de forma independente das SDKs disponibilizadas. O único passo necessário para o teste das requisições é o cadastro de uma App com um EndPoint do serviço desenvolvido. Uma vez criada a App e configurada no sistema, o cliente pode testar as chamadas em documentação das APIs.

A documentação tem a habilidade de validar as requisições feitas de e para o cliente, com os modelos de envio e resposta para melhor depuração da comunicação entre as plataformas.

Teste

O ambiente fornece o acesso as APIs através do portal de documentação, que lista as especificações das chamadas e possibilita requisições de teste através de um navegador. Acessando a documentação das APIs, é possível selecionar um EndPoint para apontar a requisição dos testes, modificando os parâmetros e verificando os retornos. Isso faz com que o sistema mande a requisição editada para o EndPoint configurado, mostrando o retorno do serviço apontado.

Homologação

O sistema roda em um ambiente de desenvolvimento com requisições simples, visando somente testes que verificam o funcionamento das mesmas. No momento que o cliente se considerar pronto para a homologação, deverá entrar em contato com a Saque e Pague para maiores informações.