Subtotal: 0 kr.

No products in the cart.
Vælg en side

CC Athletics API-dokumentation

Tilbage til bloggen

Denne dokumentation beskriver, hvordan du henter dine data fra CC Athletics-databasen via REST API-slutpunkter.

Kort fortalt er trinnene:
1. Hent en API-nøgle fra dit Cloud-dashboard – og indsæt den i headeren, når du bruger følgende endpoints:
2. Brug getTeams endpoint (se nedenfor) til at hente en liste over alle hold
3. Brug getAthletes endpoint (se nedenfor) til at hente en liste over alle atleter. Brug getAthletes endpoint (se nedenfor) til at hente en liste over alle atleter

Autentificering

API-nøgle

  • Hver API-anmodning kræver en gyldig API-nøgle
  • Inkluder API-nøglen i X-API-Key headeren
  • API-nøgler kan genereres og administreres i dit ForceMate Cloud-dashboard Konto -> API-nøgler

Eksempel på godkendelse

curl https://us-central1-forcemate-desktop.cloudfunctions.net/get_athletes \
-H "X-API-Key: fm_your_api_key_here"

Slutpunkter

Få hold

  • Slutpunkt: GET https://us-central1-forcemate-desktop.cloudfunctions.net/get_teams
  • Beskrivelse: Hent alle teams for din organisation
  • Svarformat:
{
  "teams": [
    {
      "id": "team_123",
      "name": "Team Alpha",
      "creation_date": 1623456789
    }
  ]
}

Få atleter

  • Slutpunkt: GET https://us-central1-forcemate-desktop.cloudfunctions.net/get_athletes
  • Beskrivelse: Hent atleter inklusive alle optagelser (eventuelt filtreret efter hold)
  • Forespørgselsparametre:
    • team_id (valgfrit): Filtrer atleter efter specifikt hold
    • min_birth_year (heltal, valgfrit)
      • Filtrer atleter, der er født i eller efter dette år
      • Et eksempel: min_birth_year=1990
    • max_birth_year (heltal, valgfrit)
      • Filtrer atleter, der er født i eller før dette år
      • Et eksempel: max_birth_year=2005
    • tests_date_from (streng, valgfri)
      • Filtertest optaget på eller efter denne dato
      • Format: ÅÅÅÅ-MM-DD
      • Et eksempel: tests_date_from=2024-01-01
    • tests_date_to (streng, valgfri)
      • Filtertest optaget på eller før denne dato
      • Format: ÅÅÅÅ-MM-DD
      • Et eksempel: tests_date_to=2024-12-31
    • analysis_type (streng, valgfri)
      • Filtrer efter analysetype
      • Gyldige værdier: “spring”, “isometrisk”
      • Et eksempel: analysis_type=jump
    • isometric_exercise_names (streng, valgfri)
      • Kommasepareret liste over navne på isometriske øvelser, der skal inkluderes
      • Gælder kun, når analysis_type er “isometric”
      • Et eksempel: isometric_exercise_names=Mid-thigh pull,Squat
  • Svarformat:
{
  "athletes": [
    {
      "id": "athlete_456",
      "name": "John Doe",
      "team_id": "team_123",
      "player_info": {},
      "recordings": []
    }
  ],
  "total": 1
}

Fejlhåndtering

  • 401 Unauthorized: Ugyldig eller manglende API-nøgle
  • 500 Internal Server Error: Uventet problem på serversiden

Prisgrænser

  • Takstgrænser gælder for at forhindre misbrug
  • Kontakt support for detaljer om specifikke prisgrænser

Støtte

Bedste praksis

  • Hold din API-nøgle fortrolig
  • Brug HTTPS til alle API-anmodninger
  • Implementer korrekt fejlhåndtering i din klient