Neste guia você conhece o portal Itaú for Developers e o formato das nossas documentações: como criar o seu acesso, como encontrar a solução que precisa e o que cada aba da documentação de uma API traz.
Primeiro acesso
Para iniciar sua jornada, é necessário criar uma conta. Ela pode ser criada por autocadastro ou por um usuário administrador.
| Forma de cadastro | Quem faz | Indicado para |
|---|---|---|
| Autocadastro | O próprio usuário | Quem ainda não tem ninguém da empresa cadastrada no portal |
| Cadastro por usuário administrador | Um usuário administrador da empresa | Quem vai se integrar ao contexto de uma empresa já cadastrada |
Autocadastro
O autocadastro oferece um autosserviço onde o usuário pode criar sua própria conta.
Cadastro por usuário administrador
O usuário administrador deve enviar um convite para outro usuário, que 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.
Conheça nossas soluções
Em nosso catálogo, você pode buscar todas as soluções que deseja por meio de uma busca simples ou 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
A documentação de cada API é organizada em três abas:
| Aba | O que você encontra | Sempre presente |
|---|---|---|
| Visão geral | Detalhes sobre o propósito, o uso e as regras da API | Sim |
| API reference | Endpoints, parâmetros, domínios, autenticação e collections | Sim |
| Informações adicionais | Conteúdos complementares, como padrões de erro | Não (opcional) |
Visão geral
Aqui, estão todos os detalhes pertinentes sobre a API, como:
- Público-alvo
- Restrições de uso
- Conhecimentos técnicos necessários
- Quais necessidades essa API ajuda a resolver
- Regras de negócios
- Tempo aproximado para realizar a integração
Confira abaixo como se encontra a página da visão geral:
API reference
Nesta página, estão os endpoints, parâmetros e domínios disponíveis da API, além de informações como:
- Autenticação
- Endpoints
- Collections
Você pode realizar os downloads e utilizar nossa collection: OpenAPI 3.0.0 e Postman.
Confira abaixo como se encontra a página da API reference:
Informações adicionais
Esta seção é opcional, porém, quando presente na documentação, oferece informações complementares que facilitam o uso da API, incluindo:
- Padrões de erro
- Outras seções específicas de cada API
Confira a seguir a aba informações adicionais:
Perguntas frequentes (FAQ)
Preciso de conta para ver as documentações?
Sim. O catálogo de soluções, as documentações completas e o Sandbox ficam na área logada do portal. Crie a sua conta por autocadastro ou por convite de um usuário administrador da sua empresa.
Qual a diferença entre autocadastro e cadastro por usuário administrador?
No autocadastro você mesmo cria a sua conta. No cadastro por usuário administrador, o administrador da sua empresa envia um convite e você completa o cadastro já integrado ao contexto da empresa.
Criei minha conta e não vejo o catálogo de soluções. O que fazer?
O acesso ao catálogo depende da assinatura do contrato. Se a sua empresa ainda não assinou, procure o comercial.
Toda documentação tem a aba "Informações adicionais"?
Não. Ela é opcional e aparece somente quando a API tem conteúdos complementares, como padrões de erro.
Suporte
Se sua empresa já estiver em processo de implementação, responda ao e-mail com as orientações já recebidas ou entre em contato com seu gerente de relacionamento.