O recurso Try It permite que você interaja com nossas APIs diretamente pela documentação. Ele oferece um playground integrado onde você pode testar requisições e respostas reais em um ambiente seguro e controlado.
Cada requisição enviada pelo Try It é executada contra nosso sandbox. Se você quiser entender como o sandbox funciona nos bastidores, confira a página Usando nosso Sandbox.
O que você pode fazer
Com o Try It, você pode:
- Enviar requisições ao vivo para nosso ambiente sandbox
- Inspecionar detalhes completos de requisição e resposta HTTP
- Ajustar headers, parâmetros e payloads do 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ê precisará dos headers obrigatórios para cada API. Exemplos incluem Authorization, X-Lerian-Id ou X-Organization-Id. Cada endpoint especifica exatamente quais headers você deve usar.
O sandbox é redefinido automaticamente todos os dias.Qualquer entidade que você criar, como Organizações, Ledgers ou Portfólios, será excluída em até 24 horas.Ao testar endpoints dependentes, crie as entidades necessárias novamente antes de enviar novas requisições.Por exemplo, você deve criar uma Organização antes de criar um Ledger. Use o organization_id retornado no caminho.
Como usar
O recurso Try It está disponível apenas na versão mais recente da nossa documentação.Se o botão Try It estiver ausente, mude para a versão mais recente usando o seletor no topo da página.
Abra qualquer endpoint na Referência da API.
Clique no botão Try It ao lado do caminho do endpoint.
Preencha os campos de entrada, como parâmetros de consulta, conteúdo do corpo ou headers.
Clique em Send Request para executar a chamada.
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 maneira simples de passar dos testes na documentação para executar chamadas no seu ambiente local.
