Referência completa: navega por todos os endpoints e schemas, e faz pedidos ao vivo, na referência interativa da API. Esta página é o guia rápido; tudo o resto está lá.
A API da VeloPeak é só de leitura. Expõe os treinos agendados e as atividades concluídas do atleta que autorizou, e permite que a tua aplicação subscreva webhooks. A autenticação é OAuth 2.0 (authorization code com PKCE).
URL base: https://velo-peak.com/api/v1
1. Regista a tua aplicação
Na VeloPeak, abre Definições → Programador e cria uma aplicação. Recebes um client_id e um client_secret (mostrado uma única vez) e escolhes:
- Redirect URIs, para onde o atleta regressa após autorizar.
- Âmbitos de que a tua aplicação precisa:
athlete:read,workouts:read,activities:read,webhooks. Seleciona só o que usares; o ecrã de consentimento mostra exatamente esses.
2. Obtém a autorização do atleta
Encaminha o atleta para o 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 inicia sessão, aprova o ecrã de consentimento e regressa ao teu redirect_uri com um code. Troca-o 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
Recebes um access_token e um refresh_token.
3. Chama a API
Envia 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. Recebe eventos (opcional)
Com o âmbito webhooks, regista um callback para seres notificado quando treinos ou atividades mudarem. Cada entrega é assinada com o header X-VeloPeak-Signature (HMAC-SHA256). A referência documenta o endpoint de subscrição e o payload.
Abre a referência da API para testar os endpoints com o teu token.