Introduction à l'API REST
SportsPress 2.0 a introduit des points de terminaison pour l'API REST WP, permettant un accès programmatique pour gérer les données du site. Le plugin nécessite le plugin WP REST API (version 2) pour les fonctionnalités de base. WordPress 4.7 et versions ultérieures incluent l'API REST nativement — aucun plugin supplémentaire n'est requis sur les installations WordPress modernes.
Les requêtes GET (lecture de données) ne nécessitent pas d'authentification. Les requêtes POST, PUT et DELETE (création, mise à jour ou suppression de données) nécessitent une authentification.
URL de base
Tous les points de terminaison de l'API REST SportsPress sont disponibles sous :
/wp-json/sportspress/v2/
Remplacez example.com par le domaine de votre site :
https://example.com/wp-json/sportspress/v2/events
Points de terminaison disponibles
Ressource | Point de terminaison |
Événements |
|
Équipes |
|
Joueurs |
|
Staff |
|
Calendriers |
|
Tableaux de ligue |
|
Listes de joueurs |
|
Chaque point de terminaison prend en charge les conventions standard de l'API REST WordPress : lister toutes les ressources avec GET, récupérer une seule ressource avec GET /{id}, créer avec POST, mettre à jour avec PUT ou PATCH, et supprimer avec DELETE.
Méthodes HTTP
Méthode | Action |
| Récupérer une ou plusieurs ressources |
| Créer une nouvelle ressource |
| Mettre à jour une ressource existante |
| Supprimer une ressource |
Authentification
L'authentification est requise pour toutes les opérations d'écriture. Consultez l'article Authentification pour les instructions de configuration avec les Mots de passe d'application et Postman.
Limitations connues
Les joueurs créés via l'API REST peuvent ne pas apparaître automatiquement dans les listes de joueurs. Après avoir créé un joueur via l'API, assignez manuellement le joueur à l'équipe correspondante dans l'administration, ou assurez-vous que la liste de joueurs est configurée pour inclure cette équipe.
Les événements programmés (futurs) nécessitent la valeur de statut
futurelors de la création via l'API.Le paramètre de requête
_fieldsest pris en charge pour filtrer les champs de réponse (disponible dans SportsPress Pro 2.7.16 et versions ultérieures après une correction d'une erreur API avec_fields).