primeiro acesso
Para iniciar sua jornada é necessário a criação de uma conta, ela pode ser criada por autocadastro e por um usuário administrador.
Autocadastro
O autocadastro traz o autosserviço onde o usuário pode criar sua própria conta.
Após o autocadastro, caso não tenha assinado o contrato, para obter acesso ao catálogo de soluções, procure o comercial.
Cadastro por usuário administrador
O usuário administrador deve enviar um convite para outro usuário que, por sua vez, deve completar o cadastro e integrar-se ao contexto da empresa.
Login
Após criação do acesso, realize o login. Para isso, na página inicial, clique em login e preencha os campos solicitados.
encontre sua solução
Temos um catálogo de soluções padronizado e centralizado, que promove produtividade aos desenvolvedores que consomem nossas aplicações. Aqui, antes do consumo, você pode realizar testes no portal ou no Postman.
Assim, é possível ter conhecimento do comportamento dos testes de forma fácil e acessível.
Conheça nossas soluções
Em nosso catálogo, você pode buscar todas as soluções que você deseja por meio de uma busca simples ou até mesmo definir um filtro na pesquisa, conforme sua preferência.
Após a busca, é possível visualizar a documentação completa da aplicação.
Sobre a API
Na documentação da API escolhida, você encontra:
Visão geral
Aqui, contém todos os detalhes pertinentes sobre a API, como:
Confira a imagem abaixo de como se encontra a página da visão geral:
API reference
Nessa página estão os endpoints, parâmetros e domínios disponíveis da API, além de informações como:
E ao se tratar de testes, você pode testar diretamente no ambiente de sandbox, basta apenas acionar o botão Habilitar teste e preencher os campos correspondentes. Você também pode realizar os downloads e utilizar nossa collection: OpenAPI 3.0.0 e Postman.
Confira a imagem abaixo de como se encontra a página da API reference:
Informações adicionais (opcional)
Esta aba é considerada opcional, porém, uma vez encontrada na documentação, pode-se observar os detalhes sobre: endpoints, status indicando sucesso ou falhas retornadas das requisições e os exemplos de oneOf.
Confira a imagem abaixo de como se encontra a página da informações adicionais:
Histórico de atualizações
Aqui, você encontra as versões anteriores da API, disponibilizadas: por data da publicação, descrição e o contexto de cada modificação.
Confira a imagem abaixo de como se encontra a página da histórico de atualizações:
teste a solução
O portal Itaú for Developers disponibiliza formas para testar e implementar a sua solução, são eles:
Sandbox
O sandbox é uma ferramenta que possibilita que as APIs sejam testadas, para facilitar o desenvolvimento de soluções, conhecer e aprender mais sobre as APIs do portal, além de testar a aplicabilidade das suas funcionalidades e garantir que todas as regras definidas para o uso das APIs sejam consideradas, de forma que o seu negócio possa operar livre de erros.
No sandbox, uma aplicação pode executar as mesmas operações que executa em ambiente de produção. Isso te ajuda a entender qual estrutura deve ser utilizada em suas soluções. Contudo, não existe ligação entre o ambiente de sandbox e o de produção, logo, todas as informações retornadas nos testes são fictícias, com o uso de respostas pré cadastradas, não havendo relação alguma com as informações de produção.
Homologação
Homologação é o ambiente que proporciona um fluxo completo de uso da solução, onde os processos desenvolvidos não são refletidos em operações reais.
Produção
Produção é o ambiente real, operacional, onde o processo é refletido em operações reais.
crie suas credenciais de sandbox
Para acessar o ambiente de testes do portal Itaú for Developers, você precisa de apenas um par de credenciais sandbox (client_id e client_secret) geradas dentro do portal e um token válido do sandbox gerado via portal ou Postman.
Essas chaves são válidas apenas para acessar o nosso ambiente de testes, ou seja, você precisa de novas chaves quando a sua aplicação estiver pronta para produção.
Após navegar pelo catálogo de APIs e explorar as documentações:
- Abra a API que deseja testar e clique em API reference;
- Clique no botão gerar credenciais (client_id e client_secret), no bloco credenciais.
As credenciais são criadas apenas uma vez para cada usuário.
Para o teste via Postman, o token é gerado na própria ferramenta. Para o teste dentro do portal, siga as próximas etapas:
- Clique no botão gerar token;
- O token é exibido logo abaixo de suas credenciais e você pode testar no console de testes da página API reference.
Cada token gerado possui validade de 5 minutos.
Uma vez obtido o token válido para o sandbox, você pode iniciar os testes das APIs.
É importante ressaltar que os tokens gerados para o sandbox só podem chamar a URL de sandbox, assim como os tokens de produção habilitam apenas o consumo dos dados reais. Essa regra existe para evitar que seja realizada uma chamada para o ambiente de produção com um token válido de sandbox.
Confira abaixo a URL sandbox:
Base URL: devportal.itau.com.br/sandboxapi/
teste via portal
Teste os parâmetros da API na página API reference.
Abaixo do bloco Authentication, você encontra os endpoints que fazem parte da API escolhida. Para testar os endpoints:
Selecione o método que deseja testar;
Clique no switch Habilitar teste, localizado no console de testes da API reference;
Preencha os parâmetros solicitados;
Clique em testar.
Ao final você obtém o resultado dessa requisição.
Não é necessário inserir o token em nenhum dos parâmetros, pois ao enviar a requisição via portal a validação ocorre automaticamente para o processamento da chamada e o retorno da resposta da operação.
O sandbox é composto por dados mockados e não possui guarda de estado.
teste via Postman
Postman é um cliente REST utilizado para teste de APIs, que permite ao usuário: enviar solicitações, salvar respostas, adicionar testes e criar fluxos de trabalho.
O portal Itaú for Developers disponibiliza uma collection para auxiliar a configuração do ambiente de testes no Postman. Faça o download no link abaixo e siga as instruções do processo de importação da collection.
download: postman collection v.2
- Após baixar a collection, extraia os arquivos;
- Abra o Postman, no canto superior esquerdo clique em Import > Upload files, selecione os arquivos (sandbox.postman_collection.json e SANDBOX_PRD_ENV.postman_environment.json) e clique em Import;
- No menu lateral esquerdo, clique em Environments e selecione SANDBOX_PRD_ENV;
- Na coluna CURRENT VALUE, informe o seu client_id e o seu client_secret nos respectivos campos;
- Clique em Save;
- No canto superior direito selecione o ambiente SANDBOX_PRD_ENV ( no dropdown de seleção de environment);
- Clique na requisição POST /auth presente na collection de sandbox e clique em Send, pois é necessário realizar uma requisição para receber o token de sandbox do portal;
- Para montar suas requisições para o sandbox, siga o exemplo da requisição presente na collection.
O token tem validade de 5 minutos e é armazenado automaticamente na variável sandbox_token do environment SANDBOX_PROD_ENV e pode ser utilizado em outras requisições.