Documentation Oauth2
Cette page vous indique la procédure de connexion de votre application aux comptes VisuGPX de vos utilisateurs via une version simplifiée de Oauth 2
- 1. Déclarez votre application et son adresse de redirection Redirect URL sur la page /api/, et récupérez les paramètres client ID et client secret associés
- 2. Envoyez vos utilisateurs sur la page /api/authorise (voir ci-dessous) pour qu'ils autorisent votre application à se connecter à leur compte
- 3. Lorsque vos utilisateurs ont donné leur autorisation, ils sont redirigés vers votre adresse de redirection Redirect URL avec un code d'autorisation. Echangez ce code d'autorisation contre un token d'accès sur la page /api/token (voir ci-dessous)
- 4. Stockez ce token d'accès dans votre base de donnée et utilisez-le pour sécuriser les requêtes API (documentation API)
- 5. Vous pourrez supprimer l'autorisation sur la page /api/deauthorise (voir ci-dessous)
GET
/api/authorize
Demande le consentement de vos utilisateurs pour que votre application puisse se connecter à VisuGPX en leur nom et récupère un code d'autorisation
Paramètres (* = requis) :
- client_id* -> ID de l'application cliente (l'application est à créer sur la page /api/)
- scope* -> "read" ou "write" (droits que vous demandez pour le compte de l'utilisateur. "read" = Lecture seule, "write" = lecture + écriture)
- state -> identifiant (un paramètre qui sera retourné avec la réponse, qui vous permet par exemple d'identifier l'utilisateur. Facultatif)
Exemple :
https://www.visugpx.com/api/authorize?client_id=27&scope=write&state=785
En cas d'acceptation :
L'utilisateur est redirigé vers la page Redirect URL avec les paramètres suivants
- code={code} (code d'autorisation qu'il faudra échanger par un token d'accès)
- scope="read" ou "write" (le scope qui a été demandé dans la requête)
- state={state} (si state était présent dans la requête)
Exemple : https://yourwebsite.com/api/?code=GfCvH8uxdG1LQ4eqV48FnpqWO&scope=write&state=785
En cas de refus :
L'utilisateur est redirigé vers la page Redirect URL avec les paramètres suivants
- erreur="refus" (l'utilisateur a refusé de donner son autorisation)
Exemple : https://yourwebsite.com/api/?erreur=refus
POST
/api/token
Echange le code d'autorisation reçu lors du consentement de l'utilisateur par un token d'accès définitif qui permet de sécuriser les requêtes API sur le compte de l'utilisateur
Paramètres (* = requis) :
- code* -> code d'autorisation reçu précédemment
- client_id* -> ID de l'application cliente
- client_secret* -> Mot de passe de l'application cliente
Exemple cURL :
curl -X POST -F "code=GfCvH8uxdG1LQ4eqV48FnpqWO" -F "client_id=27" -F "client_secret=JFV7ZFhdJqwQZ28MVDN4hJOFa" "https://www.visugpx.com/api/token"
Réponse :
JSON [
Voir] avec le token d'accès et le scope ou
JSON {"ERROR":"
type"}
POST
/api/deauthorize
Supprime l'autorisation
Paramètres (* = requis) :
- access_token* -> token d'accès à supprimer
Exemple cURL :
curl -X POST -F "access_token=JFV7ZFhdJqwQZ28MVDN4hJOFo" "https://www.visugpx.com/api/deauthorize"
Réponse :
JSON {"SUCCESS":"true"} ou JSON {"ERROR":"INVALID ACCESS_TOKEN"}
Nous avons pris en compte votre choix.
Vous souhaitez maîtriser les informations qui peuvent être recueillies lors de votre navigation et avez refusé les cookies de personnalisation des annonces, c'est légitime.
Parce que le service fourni par VisuGPX a un coût, accepteriez-vous quand même que nous utilisions des cookies pour vous présenter des annonces non personnalisées ? Ces cookies ne sont pas des cookies de tracking mais de simples des cookies techniques de diffusion qui garantissent le respect votre vie privée.
ForumsToposLes plus belles randosSegments
Offre Premium
Connexion
Pour soutenir VisuGPX, faites le bon choix