Introduction
URL de base de l’API : https://franckymobile.com/api/c2b4wp/
Tous les appels de l’API commencent par cette URL à laquelle s’ajoute la version ainqi que le chemin vers l’action désirée.
Exemple : https://franckymobile.com/api/c2b4wp/v1/clubs
L’API est accessible uniquement via le protocole HTTPs et n’accepte que les requêtes HTTP GET.
Authentification
Toutes les requêtes ne doivent être authentifiées pour être exécutées. Aucun utilisateur n’est requis.
Statut du retour, liste des codes
Chaque appel à l’API donne lieu à une réponse, retournant un code spécifique en fonction du résultat obtenu. L’analyse de ce code vous permet de vous assurer que la requête a été traitée avec succès.
Tous les codes >= 400 indiquent que la requête n’a pas été traitée avec succès par nos serveurs.
- 200: OK
- 202: L’analyse est en cours de traitement
- 204: Aucune donnée disponible ou ajoutée (la requête est bien formée, mais aucune donnée ne correspond)
- 206: La requête est bien traitée mais le résultat n’est pas complet : l’analyse n’est pas complète (certaines bonnes pratiques sont manquantes, par exemple) ou tous les ajouts n’ont pas pu être effectués (pour les évènements par exemple)
- 400: Paramètre manquant, ou valeur incorrecte
- 403: Action non autorisée (crédits épuisés, URL non autorisée, etc)
- 404: Page inaccessible (URL inconnue / impossible d’accéder à l’adresse)
- 408: Dépassement du temps maximal autorisé pour l’analyse
- 417: La dernière analyse de la surveillance automatique ne s’est pas déroulée correctement
- 500: Erreur inconnue, contactez-nous
- 503: L’API est momentanément indisponible, réessayez dans quelques minutes
Liste des actions
GET v1/clubs
GET v1/ride
