Synup
Créer une clé
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, "/".
successUrlstringfacultatif
Où le navigateur du client est envoyé après une connexion réussie. Doit être enregistrée sur la clé d'API et fournie avec errorUrl.
errorUrlstringfacultatif
Où le navigateur est envoyé si la connexion échoue ou est annulée. Même règle d'enregistrement, et fournie avec successUrl.
Réponse
dataobjectfacultatif
providerstring (google | facebook | apple)facultatif
Quel publisher cette URL connecte : google, facebook ou apple.
locationIdstringfacultatif
L'emplacement auquel cette connexion est associée, ou null lorsque la connexion a été démarrée avec un clientId.
clientIdstringfacultatif
Le client auquel cette connexion est limitée, ou null.
urlstringfacultatif
L'URL d'autorisation — à ouvrir dans un navigateur sous le contrôle du titulaire du compte.
successUrlstringfacultatif
La successUrl utilisée pour cet appel, ou null en mode hérité.
errorUrlstringfacultatif
L'errorUrl utilisée pour cet appel, ou null en mode hérité.
notestringfacultatif
Indications pour ouvrir l'URL. Explique le relais partenaire lorsque successUrl et errorUrl sont définies, ou le flux d'interrogation de GET /api/v1/connections sinon.
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
successUrl
errorUrl
{
  "data": {
    "provider": "google",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
    "successUrl": "https://app.example.com/oauth/done",
    "errorUrl": "https://app.example.com/oauth/failed",
    "note": "Open this URL in a browser under the account owner's control. When the connect settles, the browser is sent to your successUrl (with ?code=...&status=...&connected_account_id=...) or errorUrl (with ?error=...). Exchange the code server-side at POST /api/v1/connections/handoff/exchange within 10 minutes for the connection id and the email that authorised."
  }
}

Guides qui utilisent cet endpoint