Pular para o conteúdo principal

Primeiros passos com a API pública da Jump

Este guia mostra como realizar sua primeira requisição com sucesso.

Pré-requisitos​

  • Uma conta Jump com acesso à API pública.
  • Um token de API válido.
  • URL base do ambiente (sandbox/homologação/produção). Em produção (API Aberta/Web): https://new-web.jumpparkiapi.com.br (endpoints em /api, ou seja, https://new-web.jumpparkiapi.com.br/api).

1. Obtenha suas credenciais​

As credenciais da API pública são compostas por dois valores que devem ser usados em conjunto:

  • userId: identificador numérico do usuário, enviado na URL dos endpoints (exemplo: /api/{userId}/...).
  • Token (api_key): chave secreta enviada no header Authorization: Bearer <YOUR_API_TOKEN>.

Como gerar no Site Admin​

  1. Acesse o painel administrativo da Jump em API Aberta (Site Admin).
  2. Clique em Novo token de API Aberta e informe um nome descritivo para identificar a integração.
  3. Selecione o(s) estabelecimento(s) que o token poderá consumir.
  4. Defina, opcionalmente, uma data de expiração para o token.
  5. Ao confirmar, copie imediatamente o userId e o token exibidos — o valor do token não é exibido novamente após o fechamento do modal.

Regras e limites​

  • Cada estabelecimento aceita no máximo 2 tokens de API Aberta ativos simultaneamente.
  • Tokens com expires_at definido deixam de autorizar requisições após a data informada.
  • Apenas usuários com perfil autorizado no Site Admin podem criar, editar ou revogar tokens.

Armazenamento seguro​

  • Nunca versione o token no código-fonte ou em repositórios públicos.
  • Armazene as credenciais em cofres de segredos (vault) ou variáveis de ambiente.
  • Rotacione os tokens periodicamente e revogue imediatamente qualquer credencial comprometida.

Consulte Autorização para detalhes do cabeçalho Authorization e erros de autenticação.

2. Faça sua primeira chamada​

curl -X GET "$JUMP_API_BASE_URL/api/status" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Accept: application/json"

Veja a Referência da API para todos os endpoints.

3. Próximos passos​