Bienvenue sur la documentation de l'API de Buzzers.fit ! Cette API vous permet d'accéder aux données de votre application de classement en ligne.
Pour accéder aux données de l'API, vous devez vous authentifier en utilisant votre nom d'utilisateur et mot de passe. Vous recevrez alors un jeton d'accès (Bearer Token) que vous devrez inclure dans les en-têtes de votre requête pour accéder aux ressources protégées.
POST /connect
Content-Type: application/json
{
"client_id": "votre_nom_d_utilisateur",
"client_secret": "votre_mot_de_passe"
}
Réponse :
200 OK
Content-Type: application/json
{
"access_token": "votre_jeton_d_accès"
}
Pour utiliser votre jeton d'accès, ajoutez-le à l'en-tête "Authorization" de vos requêtes sous la forme "Bearer votre_jeton_don_d'accès".
Voici un exemple de requête HTTP qui utilise le jeton d'accès pour accéder à la liste des WODs d'une compétition :
GET /competition/{id_competition}/wod/ HTTP/1.1
Host: votre_domaine.com
Authorization: Bearer votre_jeton_d'accès
Voici un exemple de réponse qui vous sera renvoyée si la requête est autorisée :
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"wods": [
{
"id": "1",
"name": "WOD 1",
"description": "Description du WOD 1"
},
{
"id": "2",
"name": "WOD 2",
"description": "Description du WOD 2"
}
]
}
Voici un exemple de réponse qui vous sera renvoyée si la requête n'est pas autorisée :
HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"status": "error",
"message": "Unauthorized"
}
Voici la liste des routes disponibles dans l'API Buzzers.fit :
GET /competition/{id_competition}/wod/ : permet de récupérer la liste des WODs d'une compétition.
GET /competition/{id_competition}/wod/{id_wod} : permet de récupérer les détails d'un WOD.
GET /competition/{id_competition}/spot/ : permet de récupérer la liste des équipes inscrites à une compétition.
GET /competition/{id_competition}/spot/{id_spot} : permet de récupérer les détails d'une équipe.
GET /competition/{id_competition}/heat/ : permet de récupérer la liste des heats d'une compétition.
GET /competition/{id_competition}/heat/{id_heat} : permet de récupérer les détails d'un heat.
GET /competition/{id_competition}/heat/{id_heat}/line/ : permet de récupérer la liste des lignes d'un heat.
GET /competition/{id_competition}/heat/{id_heat}/line/{id_line} : permet de récupérer les détails d'une ligne.
Voici quelques exemples de requêtes à l'aide de cURL :
// Récupérer la liste des compétitions
curl -X GET \
https://buzzers.fit/competition/ \
-H 'Authorization: Bearer votre_jeton'
// Récupérer les détails d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b \
-H 'Authorization: Bearer votre_jeton'
// Récupérer la liste des WODs d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/wod/ \
-H 'Authorization: Bearer votre_jeton'
// Récupérer les détails d'un WOD spécifique d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/wod/5fb1cb0a4b \
-H 'Authorization: Bearer votre_jeton'
// Récupérer la liste des équipes d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/spot/ \
-H 'Authorization: Bearer votre_jeton'
// Récupérer les détails d'une équipe spécifique d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/spot/5fb1cb0a4b \
-H 'Authorization: Bearer votre_jeton'
// Récupérer la liste des heats d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/heat/ \
-H 'Authorization: Bearer votre_jeton'
// Récupérer les détails d'un heat spécifique d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/heat/5fb1cb0a4b \
-H 'Authorization: Bearer votre_jeton'
// Récupérer la liste des lignes d'un heat spécifique d'une compétition spécifique
curl -X GET \
https://buzzers.fit/competition/5fb1cb0a4b/heat/5fb1cb0a4b/line/ \
-H 'Authorization: Bearer votre_jeton'
// Récupérer les détails d'une ligne spécifique d