Skip to main content
O recurso Try It permite interagir com nossas APIs diretamente pela documentação. Ele oferece um playground embutido onde você pode testar requisições e respostas reais em um ambiente controlado. Toda requisição enviada pelo Try It é executada contra nosso sandbox. Se você quiser entender como o sandbox funciona por baixo dos panos, confira a página Usando nosso Sandbox.

​
O que você pode fazer

Com o Try It, você pode:
  • Enviar requisições reais para nosso ambiente de sandbox
  • Inspecionar todos os detalhes das requisições e respostas HTTP
  • Ajustar headers, parâmetros e payloads de corpo
  • Testar diferentes tokens de autenticação ou IDs de organização
  • Explorar cenários de tratamento de erros e validação com dados simulados

​
Antes de começar

Você vai precisar dos headers exigidos por cada API. Alguns exemplos são Authorization, X-Lerian-Id ou X-Organization-Id. Cada endpoint especifica exatamente quais headers você deve usar.
O sandbox é reiniciado automaticamente todos os dias.Qualquer entidade que você criar, como Organizations, Ledgers ou Portfolios, será excluída em até 24 horas.Ao testar endpoints dependentes, crie novamente as entidades necessárias antes de enviar novas requisições.Por exemplo, você deve criar uma Organization antes de criar um Ledger. Use o organization_id retornado no caminho.

​
Como usar

O recurso Try It está disponível em toda página de endpoint na API Reference.Se o botão Try It não aparecer, recarregue a página ou verifique se você está na seção API Reference.
1
Abra qualquer endpoint na API Reference.
2
Clique no botão Try It ao lado do caminho do endpoint.
3
Preencha os campos de entrada, como parâmetros de consulta, conteúdo do corpo ou headers.
4
Clique em Send Request para executar a chamada.
5
Revise o corpo da resposta, o código de status e os headers exibidos abaixo da requisição.
Você pode copiar sua requisição como curl ou fetch usando as abas de código. É uma forma simples de passar de testar na documentação para executar chamadas no seu ambiente local.