/api/v4/connected-accounts/connect-googleConnecter un compte Google
Renvoie une URL OAuth permettant de lier un compte Google Business Profile à votre compte Listings API.
Paramètres
Corps
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| input | object | obligatoire | Wrapper object. The entire request body must be nested under `input`. |
| input.successUrl | string | obligatoire | URL the user is redirected to after they successfully authorize Google. Must be an absolute https URL you control. |
| input.errorUrl | string | obligatoire | URL the user is redirected to if they cancel or the authorization fails. Must be an absolute https URL you control. |
Exemple de requête
Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.
{ "input": { "successUrl": "https://listingsapi.com/docs/api/connected-accounts-trigger-matches", "errorUrl": "https://listingsapi.com/docs/api/connected-accounts-connect" }}Réponses
200OAuth URL generated successfully. Redirect the user to `url` to begin the Google authorization flow. The `url` shown is a placeholder; send the user to the `url` returned in your own response.
{ "data": { "bulkConnectLinkForGoogle": { "errors": null, "success": true, "url": "https://connect.example.com/oauth?token=8f3c1d92-..." } }}400Bad request, the body was not wrapped in `input`, or `successUrl`/`errorUrl` was omitted (error message: `Variable "$input" of required type "GoogleOauthBulkInput!" was not provided`).
401Unauthenticated, missing or invalid API key.
Génère une URL OAuth à durée de validité limitée qu’un utilisateur ouvre pour autoriser Listings API à gérer ses établissements Google Business Profile en masse. Redirigez l’utilisateur vers url renvoyé ; il suit les étapes de l’écran de consentement de Google, puis est redirigé vers l’une des URL que vous avez fournies. Le lien est valable pendant 24 heures.
Format de la requête. Le corps doit être encapsulé dans un objet input contenant deux champs obligatoires, successUrl et errorUrl. Il s’agit des URL https absolues vers lesquelles l’utilisateur est redirigé après avoir terminé (ou abandonné) les étapes de l’écran de consentement de Google ; fournissez des points de terminaison de votre propre application qui reprennent le parcours d’intégration en cas de réussite et proposent une nouvelle tentative en cas d’erreur. Il n’existe aucun champ accountId, le lien de connexion est toujours limité au compte auquel appartient la clé API, et l’envoi de accountId (ou d’un corps à plat, sans encapsulation) est rejeté avec un statut HTTP 400.
Il s’agit de la première étape du processus de connexion en masse. Une fois le compte autorisé, il apparaît dans la réponse du point de terminaison qui répertorie les comptes connectés (GET /connected-accounts), avec un connectedAccountId que vous utilisez pour chaque appel ultérieur.
Cas d’utilisation : intégration des profils Google d’un client d’agence. Un nouveau client vous confie l’accès à son compte Google Business Profile. Appelez ce point de terminaison, redirigez le client vers url renvoyé et, après son consentement, ses fiches Google deviennent disponibles dans le nouveau compte connecté. Exécutez ensuite POST /connected-accounts/trigger-matches pour associer ces fiches Google à vos établissements Listings API, vérifiez les associations avec GET /connected-accounts/{connectedAccountId}/connection-suggestions, puis finalisez-les avec POST /connected-accounts/confirm-matches.
Cas d’utilisation : rétablissement d’identifiants expirés. Lorsque le jeton Google d’un compte connecté expire, les mises à jour des fiches ne sont plus synchronisées. Générez un nouveau lien de connexion avec ce point de terminaison et demandez au propriétaire du compte d’accorder à nouveau l’autorisation ; la connexion existante est actualisée plutôt que dupliquée.
Pour Facebook, utilisez le point de terminaison connect-facebook. success: true avec une valeur url non nulle signifie que le lien a été généré ; errors n’est renseigné qu’en cas d’échec de la génération.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connect-google' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "successUrl": "https://listingsapi.com/docs/api/connected-accounts-trigger-matches", "errorUrl": "https://listingsapi.com/docs/api/connected-accounts-connect" } }'