Documentação da API pública da Jump

Bem-vindo à documentação oficial da API pública da Jump. Este site é voltado para desenvolvedores que desejam integrar a Jump aos seus próprios sistemas e automatizar fluxos operacionais do dia a dia.

Use esta documentação para entender os conceitos principais, configurar seu ambiente rapidamente e explorar todas as capacidades expostas pela API.

Acessos rápidos​

• Visão geral – o que a API faz, para quem ela é indicada e como ela se encaixa na sua arquitetura.
• Primeiros passos – obtenha credenciais, escolha o ambiente e faça sua primeira requisição com sucesso.
• Autorização – cabeçalho de autenticação e erros de autorização mais comuns.
• Referência da API – documentação endpoint por endpoint.

O que você encontra aqui​

• Visão geral de alto nível – um guia conceitual de como a API pública da Jump funciona e quando utilizá-la.
• Guia de onboarding – passos para sair do zero até ter uma integração funcionando.
• Autorização – modelo de autenticação e permissões usado pela API.
• Referência da API – cada endpoint documentado individualmente.

Próximos passos​

Se você está começando agora, comece pela Visão geral e siga o guia de Primeiros passos para fazer sua primeira requisição no ambiente desejado.

Se você já possui uma integração e quer aprofundá-la, revise a seção de Autorização e a Referência da API para detalhes de cada endpoint.