Referência completa: navegue por todos os endpoints e schemas, e faça requisições ao vivo, na referência interativa da API. Esta página é o guia rápido; todo o resto está lá.
A API da VeloPeak é somente leitura. Ela expõe os treinos agendados e as atividades concluídas do atleta que autorizou, e permite que seu app assine webhooks. A autenticação é OAuth 2.0 (authorization code com PKCE).
URL base: https://velo-peak.com/api/v1
1. Registre seu app
Na VeloPeak, abra Configurações → Desenvolvedor e crie um app. Você recebe um client_id e um client_secret (mostrado uma única vez) e escolhe:
- Redirect URIs, para onde o atleta volta após autorizar.
- Escopos que seu app precisa:
athlete:read,workouts:read,activities:read,webhooks. Selecione só o que usar; a tela de consentimento mostra exatamente esses.
2. Obtenha a autorização do atleta
Envie o atleta ao endpoint de autorização com um desafio PKCE:
GET https://velo-peak.com/api/auth/oauth2/authorize ?response_type=code &client_id=YOUR_CLIENT_ID &redirect_uri=YOUR_REDIRECT_URI &scope=athlete:read workouts:read &state=RANDOM &code_challenge=BASE64URL_SHA256_OF_VERIFIER &code_challenge_method=S256
Ele faz login, aprova a tela de consentimento e volta ao seu redirect_uri com um code. Troque por um token:
POST https://velo-peak.com/api/auth/oauth2/token Content-Type: application/x-www-form-urlencoded grant_type=authorization_code &code=THE_CODE &redirect_uri=YOUR_REDIRECT_URI &client_id=YOUR_CLIENT_ID &client_secret=YOUR_CLIENT_SECRET &code_verifier=YOUR_PKCE_VERIFIER
Você recebe um access_token e um refresh_token.
3. Chame a API
Envie o token no header Bearer:
GET https://velo-peak.com/api/v1/workouts Authorization: Bearer ACCESS_TOKEN
A lista completa de endpoints, parâmetros e formatos de resposta está na referência da API.
4. Receba eventos (opcional)
Com o escopo webhooks, registre um callback para ser notificado quando treinos ou atividades mudarem. Cada entrega é assinada com o header X-VeloPeak-Signature (HMAC-SHA256). A referência documenta o endpoint de assinatura e o payload.
Abra a referência da API para testar os endpoints com seu token.