Primeiros Passos
Visão geral do portal
Neste tutorial serão apresentadas todas as páginas que compõem o portal para que o usuário tenha uma compreensão mais abrangente das funcionalidades do portal com a qual ele terá que envolver-se.
Embora este tutorial seja de nível iniciante, talvez seja interessante que o usuário leia as seguintes FAQs caso ainda não esteja a par com os conceitos que envolvam o portal:
Página principal
Também conhecida como a “Home” do portal, é a página que apresenta um resumo do conteúdo existente no portal e oferece os principais meios de acesso para as funcionalidades que se deseja utilizar. Veja a Figura 1:
Conforme pode ser observado na Figura 1, o portal apresenta sua página principal dividida em seções conforme numeração inserida.
Seções como Menu (1) e Rodapé (5) são seções fixas que aparecerão constantemente, independente da página. Há possibilidade de variação do conteúdo destas seções de acordo com as funcionalidades acessadas ou até suprimidas em alguns casos (tela de cadastro e login por exemplo) mas de forma geral elas se manterão presente.
A parte central da página principal é totalmente dinâmica e irá variar de acordo com o link acessado.
Dentro da Home, são apresentados alguns cards que levam diretamente para a documentação pública das APIs disponíveis no portal e caso queira acessar a documentação destas APIs basta clicar no botão denominado “Ver mais” que você será redirecionado para a página da respectiva documentação conforme mostrado na Figura 2 que se segue:
A Figura 2 apresenta uma estrutura de documentação padronizada para documentar APIs conhecida como ReDoc.
Para conhecer mais detalhes sobre como ler a documentação da API acesse o tutorial: Como Visualizar a Documentação de uma API
Para conhecer mais sobre as APIs que estão disponíveis no portal do desenvolvedor do Banestes acesse a FAQ “Quais APIs do Banestes estão disponíveis no portal do desenvolvedor?”
Menu Principal
O Menu principal (seção x) é composto pelos links que irão leva-lo às demais páginas do portal. Quando o usuário não estiver logado serão exibidos dois menus de grupos:
O Primeiro Menu
O Segundo menu (Como funciona>) apresenta links para as Páginas de Suporte além de apresentar telefone e e-mails para contato. Veja a Figura 5:
Como pode ser observado na Figura 5, existem aqui links referentes aos Tutoriais (Figura 6) e links referentes aos FAQs (Figura 7)
Na Figura 6, são apresentados os tutoriais categorizados conforme os níveis de dificuldade:
- Primeiros passos: tutoriais básicos para conhecer e se cadastrar no portal;
- Conhecendo as APIs: tutoriais específicos sobre a Documentação das APIs, e
- Usando as APIs: tutoriais específicos para testes das APIs.
Já a Figura 7, são mostrados os links para que levam diretamente às duvidas mais comuns e frequentemente questionadas ao suporte, sendo respectivamente:
- Portal do desenvolvedor: Questões envolvendo o portal propriamente dito;
- API Pix: envolvendo questões sobre o uso da API Pix
- API dados Públicos: envolvendo questões frequentes sobre o uso das APIs públicas.
Login e Cadastro
Conforme a Figura 1, mostrada no início deste tutorial, é possível observar no canto superior direito, a presença de dois botões que direcionam o usuário às respectivas páginas para inserir o login do usuário ou à página de cadastro.
Ao clicar no botão 
surge a página composta de um formulário para inserir login e senha conforme apresentado na Figura 8, lembrando que para ter
login e senha será necessário fazer previamente um cadastro, utilizando a página de cadastro através do botão 
. A página de cadastro pode ser vista na imagem da
Figura 9 ao lado:
Caso seja do interesse do usuário entender melhor como funciona o processo de login e cadastro, é possível saber mais acessando os tutoriais: “Como se cadastrar no portal” e “Como se autenticar no portal”
Área Logada
Quando o usuário efetua o login, o menu principal modifica seu contexto apresentando a informação do usuário logado e um novo grupo de menu que permite acessar partes exclusivas do portal . Observe a Figura 10:
Conforme visto na Figura 10, neste menu você encontrará links para levar o usuário às seguintes páginas:
- Minhas aplicações: onde o usuário pode gerenciar as aplicações por ele criada;
- Nova aplicação: onde o usuário poderá criar novas aplicações;
- Minha Equipe: página para envio de mensagens ao suporte técnico do portal, e por fim
- Suporte: Para acessar a página de envio de mensagens para o suporte técnico.
- Sair: uma opção para sair da área logada.
É importante salientar que para cada um dos itens mencionados de 1 à 5 deste menu, existe um tutorial associado que permitirá um melhor entendimento das funcionalidades do portal. Seguem respectivamente os links para os tutoriais:
Página Minhas Aplicações
Na figura acima (Figura 11) é apresentado a página Minhas aplicações, onde o usuário poderá gerenciar suas aplicações ou criar novas.
Uma aplicação é um container com nome e descrição definidos para referenciar a API que será utilizada e receber as credenciais de acesso à API. Caso deseje saber mais sobre como criar ou gerenciar suas aplicações, acesse os tutoriais da seção: Como Utilizar uma API Privada
Caso não conheça o assunto envolvendo o conceito de APIs, é fortemente aconselhável que confira as FAQs:
Página Nova aplicação
O formulário apresentado na Figura 12, pertence à página responsável por criar novas aplicações no portal do desenvolvedor e pode ser acessado tanto do menu (Figura 10) como a partir da página Minhas Aplicações (Figura 11) clicando na opção +Nova aplicação. Esta página tem como objetivo permitir que o usuário crie sua aplicação e selecione a API desejada.
Para conhecer mais detalhes sobre esta funcionalidade, pode-se acessar o tutorial: Criando uma nova aplicação.
Página Suporte
Por fim, a página acessada pelo menu “Suporte” oferece um ambiente para trocar mensagens com o suporte técnico do portal e uma caixa de mensagens do sistema. O formulário apresentado nesta página é similar a uma caixa de e-mail (veja Figura 13), permitindo que o usuário mantenha um histórico das mensagens recebidas e enviadas.
Assim como as demais seções do portal, existe também um tutorial que aborda este processo e pode ser acessado através do link: Como obter suporte técnico através do portal.
