itaú for developers

O nosso sandbox

Características do sandbox

Introdução

Como obter as credenciais do sandbox

Como obter o token sandbox programaticamente

Chamando as APIs em Sandbox

Utilizando Sandbox

Testando via Portal do Desenvolvedor

Testando via Postman

Testando programaticamente

Testando nossas APIs

Com o objetivo de facilitar o desenvolvimento de soluções, o Itaú for Developers oferece um ambiente de **sandbox** que permite testar as APIs de forma segura. Acesse esse ambiente para explorar e aprender mais sobre as APIs disponíveis no portal. Além disso, você pode testar a aplicabilidade das funcionalidades e assegurar que todas as regras de uso das APIs sejam seguidas, garantindo que seu negócio opere sem erros.

  
No sandbox, uma aplicação pode executar as mesmas operações que executa em ambiente de produção. Isso te ajudará 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 serão fictícias**, não havendo relação alguma com as informações de produção.

   
- Desenvolvido em REST (Representational State Transfer)
- Especificações em Swagger e OpenAPI
- Sem guarda de estado das requisições
- Ambiente mockado

Para acessar o sandbox do Portal Itaú for Developers, não é necessária a implantação de um certificado. Você precisará de apenas um par de **credenciais sandbox (client_id e client_secret) e um token válido do sandbox**, que são criados dentro do próprio portal.

  
Essas chaves são válidas exclusivamente para o acesso ao nosso ambiente de testes. Quando sua aplicação estiver pronta para produção, será necessário obter novas chaves. Para mais informações sobre as autenticações requeridas no ambiente de produção, acesse o menu **Produção**.

    
- Navegue pelo nosso **[catálogo de APIs](/nossas-apis/todas-apis)** e explore as nossas documentações.
- Clique em **ver especificação técnica**, localizado no card da API, ou abra a API que deseja testar e clique no botão **ver especificação técnica**.
- Clique no botão **gerar credenciais** (client_id e cliente_secret), no bloco **credenciais**. Essas credenciais são criadas apenas uma vez para cada usuário.
- Em seguida, clique no botão **gerar token**. Cada token gerado possui validade de 5 minutos.
- O **token** será exibido logo abaixo de suas credenciais, e você poderá testar no console de testes da página de **especificação técnica**.

## Como obter o token sandbox programaticamente



Utilize o curl abaixo caso deseje gerar o token de forma programática:

curl --location --request POST 'https://sandbox.devportal.itau.com.br/api/oauth/jwt' \  
--header 'Content-Type: application/x-www-form-urlencoded' \  
--data grant_type=client_credentials \
--data client_id=**{{client_id}}**  \
--data client_secret=**{{client_secret}}**



  
Para obter as credenciais do sandbox (client_id e client_secret), siga o fluxo descrito em [como obter as credenciais do sandbox](#como-obter-as-credenciais-do-sandbox).



O token válido de sandbox será exibido na propriedade **access_token**, conforme o seguinte exemplo:

{    &nbsp;&nbsp;**"access_token"**:"eyJhbGciOiJIUzI1NiJ9.eyJzb3VyY2UiOiJzdHMtc2FuZGJveCIsImVudiI6IkQiLCJmbG93IjoiQ0MiLCJzY29wZSI6ImV4ZW1wbG8tc2NvcGUiLCJzdWIiOiJiNjNkNWNhZC02ZDRjLTRkNzgtYjA3NC1lZDdkMTYxMTBhYjAiLCJpYXQiOjE2NTE1MjU2MTEsImV4cCI6MTY1MTUyNjIxMX0.uA_xnbMxLfCvQh4QTx3mb7_GsoSjjdLcNoBpkF5AgPI",
&nbsp;&nbsp;"token_type":"Bearer",  
&nbsp;&nbsp;"expires_in":300,  
&nbsp;&nbsp;"active":true,  
&nbsp;&nbsp;"scope":"exemplo-scope"  
}

Após obter um token válido para o sandbox, você pode iniciar os testes das APIs. É importante destacar que as APIs no sandbox funcionam de maneira idêntica ao ambiente de produção, o que auxiliará no desenvolvimento de suas soluções.


  
É importante destacar que **os tokens gerados para o sandbox são restritos ao uso exclusivo na URL do sandbox**, enquanto os tokens de produção permitem apenas o acesso aos dados reais. Essa regra é implementada para evitar chamadas ao ambiente de produção utilizando um token válido do sandbox.



  
Para que a autenticação no sandbox seja realizada com sucesso, é essencial que a aplicação direcione para o ambiente de sandbox utilizando a URL correta.

Base URL*:
 
https://sandbox.devportal.itau.com.br/

Você pode testar os parâmetros da API na página de especificação técnica.

Sempre que você acessar uma página de teste de API pelo Portal Itaú for Developers, será necessário gerar o token no início da página para que o teste da requisição possa ser concluído. Cada token gerado possui validade de 5 minutos.


  
Abaixo do bloco de **Authentication**, você encontra os endpoints que compõem a API selecionada. Para realizar um teste, selecione um método, preencha os parâmetros necessários e envie a requisição para receber exemplos de resposta dessa chamada.


  
Não é necessário inserir o token em nenhum dos parâmetros, já que quando você fizer o envio da requisição pelo Portal, o token será validado automaticamente para realizar o processamento da chamada e retornar a resposta da operação. Lembra-se que o sandbox é composto por dados mockados e não possui guarda de estado.



    
- Visite o **[catálogo de APIs](/nossas-apis/todas-apis)** e acesse a página de especificação técnica da API que você deseja testar.
- No bloco **credenciais**, clique em **gerar token**, exibido logo abaixo das suas credenciais. Caso ainda não possua as credenciais, clique em **gerar credenciais** e, em seguida, clique em **gerar token**. 
- Selecione o método que deseja testar, clique no switch **Teste a API**, localizado no console de testes da **especificação técnica**, preencha os campos, e clique em **testar**.

Postman é um cliente REST utilizada para teste de APIs, que permite ao usuário enviar solicitações, salvar respostas, adicionar testes e criar fluxos de trabalho.

O 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.

Baixe: [**Postman Collections: Itaú for developers v.2**](https://devportalbucket.cloud.itau.com.br/devportal_sandbox_81795b3486.zip)

- Após baixar a collection, extraia os arquivos;
- Abra o Postman, clique em **Import > Upload files**, selecione os arquivos (sandbox.postman_collection.json e SANDBOX_PRD_ENV.postman_environment.json) e clique novamente 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. O client_id e client_secret podem ser obtidos na página de especificação técnica da API, conforme descrito em [como obter credenciais do sandbox](#como-obter-as-credenciais-do-sandbox);
- Para finalizar, clique em **Save**.
- Selecione o env "SANDBOX_PRD_ENV" no canto superior direito (dropdown de seleção de environment). 
- Antes de testar, é necessário realizar uma requisição para receber o token de sandbox do portal. Clique na requisição **POST /auth** presente na collection de sandbox e clique em **Send**. Observe que é necessario ter realizado o passo 4. O token terá validade de 5 minutos e será armazenado automaticamente na variável sandbox_token do environment SANDBOX_PROD_ENV e poderá ser utilizado em outras requisições;
- Para montar suas requisições para o sandbox, siga o exemplo da requisição presente na collection;

Utilize o curl abaixo para realizar o teste de forma programática:

curl --location --request **{{METODO}}** '**{{sandbox-url}}** **{{endpoint}}**' \  
--header 'Authorization: **{{token}}**' \

  
- Acesse a **especificação técnica** da API que deseja testar, navegando pelo [catálogo de APIs](/nossas-apis/todas-apis).
- Gere o token, conforme descrito em [como obter o token sandbox programaticamente](#como-obter-o-token-sandbox-programaticamente), ou clique em **gerar token** na página de **especificação técnica**. Obs: se ainda não tiver credenciais, clique em **gerar credenciais** e depois em **gerar token**.
- Copie o **token** gerado e cole no curl acima.
- Procure o endpoint que deseja testar e preencha os respectivos **método** e **endpoint**, conforme exemplo de curl abaixo. Lembrando que o método e o endpoint podem ser encontrados no console de testes, abaixo do switch **Teste a Api**.
- Por fim, clique no botão **Open API 3.0** ou **Swagger 2.0**, localizado em **Download**. Uma nova aba será aberta com a exibição da especificação.
- Copie o valor da propriedade **sandbox-url**, localizado na especificação aberta no passo anterior, e cole no curl acima.



Confira um exemplo de preenchimento do curl:

curl --location --request GET 'https://sandbox.devportal.itau.com.br/sandboxapi/endpoint_exemplo/exemplo_path_parameter?exemplo_query_parameter=exemplo' \  

--header 'Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzb3VyY2UiOiJzdHMtc2FuZGJveCIsImVudiI6IkQiLCJmbG93IjoiQ0MiLCJzY29wZSI6ImV4ZW1wbG8tc2NvcGUiLCJzdWIiOiJiNjNkNWNhZC02ZDRjLTRkNzgtYjA3NC1lZDdkMTYxMTBhYjAiLCJpYXQiOjE2NTE1MjU2MTEsImV4cCI6MTY1MTUyNjIxMX0.uA_xnbMxLfCvQh4QTx3mb7_GsoSjjdLcNoBpkF5AgPI' \  
--header 'x-header-exemplo: exemplo'  
--data-raw '{  
&nbsp;&nbsp;"body_exemplo": "exemplo"  
}'

sandbox - como começar

Sandbox - como começar

open finance

cartões

consignado

formalização remota

open contas: saldos e limites

recuperação de crédito

agendamento de pagamentos

orquestrador de análise de fraudes e riscos

feriados

iu docs

whatsapp

Financial Data

Iniciação de pagamentos

Corban Digital

Garantias

Banco Tesoureiro

DRE - Demonstração do Resultado do Exercício

Portal Experiência Iconsig

Fundos: Custódia de terceiros

Rede (adquirente)

Conexão Itaú

Câmbio e Comércio exterior

produtos

APIs e SDKs

Apps

APIs e soluções

primeiros passos

como usar sandbox

certificado dinâmico (demais produtos)

autosserviço de credenciais e certificado

autenticação mTLS

cadastro de produtos

liberar produtos

como começar

guia do expositor

dúvidas frequentes

erros comuns

colaboratech

abrir um chamado

gestão de chamados

ajuda

APIs favoritas

status dos serviços

usuários e perfis

gerenciar produtos

minha conta

empresas e usuários

gestão de empresas

operacional B2B

dashboards

ciclo de vida das APIs

exposição

gestão de credenciais

gestão de acessos

produtos e escopos

liberações de credenciais

sair

[userName]

Caso queira acompanhar o status dos serviços relacionados a PIX no portal do desenvolvedor, basta clicar em "status dos serviços" presente no lado esquerdo da página "nossas APIs"

Agora os status dos serviços de PIX está no portal do desenvolvedor

Identificamos uma questão técnica que resultou na indisponibilidade parcial do sandbox. Gostaríamos de assegurar que nossa equipe técnica está trabalhando com prioridade máxima para resolver este problema o mais rápido possível.