FAQs :: Portal do Desenvolvedor

O Banestes developers é o portal do desenvolvedor do Banestes. Um ambiente web criado com a finalidade de permitir que desenvolvedores externos e empresas parceiras, possam facilmente integrar suas aplicações com os serviços ofertados através de nossas APIs.

Dentro do portal é possível:

• Utilizar APIs Públicas
• Realizar Cadastro para utilizar as APIs de serviços que exigem contrato;
• Estudar a documentação das APIs disponíveis;
• Receber credenciais para testar as APIs em ambiente de Homologação;
• Utilizar a SandBox; e
• Gerenciar os membros da sua organização que podem ter acesso a API.

API é um conceito ligado a TI, mais precisamente dentro da área de desenvolvimento de softwares onde uma interface é criada para que sistemas distintos possam se comunicar facilmente.

No caso do portal do desenvolvedor do Banestes, as APIs são oferecidas em forma de URLs que permitem fazer solicitações ou enviar informações. Ao serem chamadas de dentro das aplicações, elas podem utilizar os serviços bancários como criar uma cobrança ou retornar uma lista de títulos compensados em um determinado período.

Atualmente o Banestes oferece APIs públicas, APIs do Pix e APIs para Open Banking. Caso queira conhecer melhor nossas APIs disponíveis, basta consultar a documentação clicando nos links:

• APIs Públicas
• APIs Pix
• APIs Open Banking

Para utilizar as APIs disponíveis no Banestes developers, seria de muita utilidade estudar as tecnologias inerentes as APIs do portal.

Abaixo segue um breve resumo destas tecnologias na intenção que o usuário investigue mais afundo suas características e como utiliza-las:

Rest/JSON

Este conceito tecnológico utilizado aqui no portal, são a junção de duas tecnologias trabalhadas em conjunto.

Rest ou Rest API é um padrão (um protocolo) que especifica a comunicação entre a aplicação do cliente. É baseado no padrão já existente utilizados em websites, onde a URL é composta de conteúdo que permite enviar informações ao servidor.

JSON é um padrão de texto estruturado com certas regras. Estas regras são conhecidas por todas as linguagens de programação. Assim que é solicitado uma informação usando REST, o serviço retorna os resultados no formato JSON, para que a aplicação trate essas informações de acordo com suas necessidades.

WebHooks

Webhook, ou também conhecido como chamada Http ou impulso API, é um mecanismo desenvolvido para transmitir informações entre dois sistemas de forma passiva e em tempo real através da web.

OAuth2

Este é um protocolo utilizado para autenticação no uso de APIs para evitar o uso constantes de senhas no momento de utilizar uma API mas ao mesmo tempo criando uma camada de segurança maior.

A premissa deste padrão é basicamente exigir ao usuário que irá consumir a API, realizar primeiramente uma autenticação em um servidor informando dois parâmetros: cliente_id e cliente_secret.

Uma vez que seja autenticado, o usuário recebe um token que será utilizado para fazer chamada nas demais APIs, tornando assim o token, uma forma de validar se a chamada foi realmente feita por quem autenticou no servidor previamente.

OpenAPI Spec 3.0

Open Api é uma especificação para padrões de APIs abertas para aplicações se comunicarem entre si. O Padrão Open API utilizado no portal é a 3.0 onde apresenta uma estrutura mais nova e simplificada.

JSON Web Tokens

Também conhecido como JWT é um padrão para realizar autenticação através de toquem assinado que pode ser utilizado para autenticar uma requisição web.

JWK e JWKS

Sigla de JSON web Key e JSON Web Key Set são terminologias que envolvem estrutura e métodos de criptografia baseadas utilizando o padrão JSON.

Geração e Leitura de QR Code

É uma alternativa ao código de barras, porém com recursos que englobam a possibilidade de englobar uma quantidade significativa de informações. Sua especificação é aberta podendo permitir que qualquer um possa implementa-lo.

Dois tipos de usuários podem ter acesso ao portal do desenvolvedor: desenvolvedores externos e representantes de organizações parceiras, que também podem ser desenvolvedores.

Caso o cadastro seja feito pelo representante da organização, imediatamente após o cadastro ser efetivado ele poderá acessar a página de gestão das aplicações onde poderá criar uma aplicação, selecionar as APIs e adicionar desenvolvedores externos na equipe.

Caso o cadastro seja feito por um desenvolver externo, após o cadastro ser efetuado, ele só conseguirá fazer login no portal após ser adicionado à uma aplicação por um representante da organização parceira.

Mais detalhes sobre a realização de cadastro no portal consulte os tutoriais de cadastros nos seguintes links:

• Tutorial de Login e Cadastro no portal

Mais detalhes sobre a realização de cadastro no portal consulte os tutoriais de cadastros nos seguintes links:

• Tutorial de Login e Cadastro no portal

Após se cadastrar você poderá criar uma aplicação selecionando as APIs desejadas. Para um tutorial mais detalhado, você poderá clicar no link tutorial para criação da aplicação.

Assim que você estiver devidamente cadastrado e logado no portado do desenvolvedor e criado devidamente a aplicação que você deseja (veja o link tutorial para criação da aplicação) você receberá credenciais para utilizar as APIs selecionadas. A utilização será feita em um ambiente de testes conhecido como sandBox, onde todas as operações realizadas utilizando as credenciais não terão valor efetivo, mas permitirão que vocês executem os serviços da mesma forma que fariam em uma aplicação rodando em produção.

SandBox consiste em um ambiente seguro, separado do ambiente real onde equipes podem trabalhar e testar operações sem que interfiram no funcionamento dos processos que estão em operação.

Trazendo este conceito para o portal do desenvolvedor, pode-se entender que sandbox representa um ambiente de testes (homologação) separado do ambiente de produção, para que você possa testar as APIs e serviços fornecidos.

Através da sandbox do Banestes developers você poderá:

1. Criar ou integrar sua aplicação consumindo serviços com o mesmo fluxo que faria no ambiente de produção;
2. Receber credenciais diferentes para ambiente da produção e homologação, garantindo assim que não haverá erros no uso do ambiente adequado;
3. Criar, editar e recuperar dados de teste ao consumir os serviços das APIs e eles estarão armazenados até que você decida excluí-los, da mesma forma que você faria em ambiente de produção;
4. Testar performance e escalabilidade dos serviços da mesma forma que faria em ambiente real, e
5. Testar todas as funcionalidades de sua aplicação e assim, quando completamente implementada e testada, poderá facilmente migra-la para o ambiente de produção.

As credenciais são uma forma de autenticar o usuário que irá consumir um serviço e fazem parte dos padrões e modelos de especificações utilizados para as APIs disponíveis neste portal (veja faqs, pergunta nº 3).

As credenciais basicamente são compostas por tokens ou hashs e para cada aplicação criada será gerada ao menos dois tokens, o cliente_id e cliente secret.

Fazendo uma analogia, estes dois tokens representam respectivamente um login e senha comuns para a aplicação que utilizará os serviços selecionados na aplicação e como sua estrutura é baseada na criptografia, os níveis de segurança são maximizados.

Todas as APIs públicas possuem documentação acessível sem necessidade de realizar login, bastando acessa-las diretamente da página principal ou pelo menu principal do portal.

É preciso salientar que a documentação dos APIs não se baseiam em um tutorial passo-a-passo e sim em uma documentação para uso técnico, sendo necessário o mínimo de domínio no consumo de webservices segundo as tecnologias apresentadas anteriormente (ver FAQs, Questão nº 3).