v1Ressources/Connexions/getObtenir une URL de connexion Google

Obtenir une URL de connexion Google

Renvoie une URL d'autorisation OAuth Google à ouvrir dans un navigateur pour connecter le Profil d'établissement Google de cet emplacement. Cet endpoint ne peut pas terminer la connexion lui-même — l'écran de consentement Google nécessite un humain interactif.

get/api/v1/connections/google/connect-url

connections:write

Paramètres de requête

locationIdstringobligatoire

L'emplacement à connecter.

clientIdstringfacultatif

Le client de l'emplacement. Nécessaire uniquement pour lever une ambiguïté lorsque votre clé est limitée à des clients spécifiques.

returnUrlstringfacultatif

Chemin interne de l'application où atterrir après que l'humain a terminé l'écran de consentement. Par défaut, "/".

Réponse

dataobjectfacultatif

providerstring (google | facebook)facultatif

Quel publisher cette URL connecte.

locationIdstringfacultatif

L'emplacement auquel cette connexion sera associée une fois approuvée.

urlstringfacultatif

L'URL d'autorisation — à ouvrir dans un navigateur sous le contrôle du titulaire du compte.

notestringfacultatif

Explique qu'il n'y a pas de rappel vers votre intégration ; interroger GET /api/v1/connections ensuite.

Erreurs

400Il manque un paramètre requis à la requête, ou elle est invalide.

401Clé API manquante, invalide, expirée ou révoquée.

403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

get/api/v1/connections/google/connect-url

Votre clé API

locationId *

clientId

returnUrl

{
  "data": {
    "provider": "google",
    "locationId": "loc_456",
    "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
    "note": "Open this URL in a browser under the account owner's control. There is no callback to your integration — once approved, poll GET /api/v1/connections to see the new connection."
  }
}