/api/v4/locations/oauth-disconnectDéconnecter un établissement d’une plateforme de publication
Rompt la connexion d’un seul établissement à une plateforme de publication, en complément de l’URL de connexion OAuth propre à chaque établissement.
Paramètres
Corps
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| input | object | obligatoire | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | obligatoire | Base64-encoded Relay ID of the one location to disconnect. |
| input.site | string | facultatif | Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`. |
| input.providerId | string | facultatif | The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`. |
Exemple de requête
Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" }}Réponses
200Connection removed. Response key `disconnectConnectedAccountsLocations`.
{ "data": { "disconnectConnectedAccountsLocations": { "clientMutationId": null, "success": true, "errors": null } }}401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to disconnect this location (`SY90003`).
Supprime la connexion d’un seul établissement à une plateforme de publication. Il s’agit du volet de déconnexion du flux OAuth propre à chaque établissement, lancé par Créer une URL de connexion OAuth pour un établissement.
Cette route et Déconnecter une fiche d’un établissement correspondent à la même opération accessible par deux chemins : les deux acceptent un corps input identique et renvoient leur résultat sous disconnectConnectedAccountsLocations, et non sous le nom de l’un ou l’autre des chemins. Choisissez le chemin qui vous semble le plus clair dans votre intégration ; leur comportement est identique.
Le corps doit être encapsulé dans input et contenir un seul locationId, ainsi que soit site, soit providerId pour indiquer la connexion à rompre. Si vous n’envoyez ni l’un ni l’autre, le point de terminaison renvoie SY10056 ("Site is not valid for the location disconnection") ; si l’établissement n’a aucune connexion active pour ce site, il renvoie SY10057 plutôt qu’un succès silencieux, de sorte que success: true signifie bien qu’un lien a été supprimé. Ce point de terminaison ne permet pas le traitement en masse ; utilisez donc une boucle pour plusieurs établissements. Pour déconnecter en une seule fois tous les établissements d’un compte, utilisez plutôt Déconnecter des comptes Google en masse.
Cas d’utilisation : annuler une connexion à la mauvaise fiche
Lorsqu’un utilisateur connecte la mauvaise fiche d’une plateforme de publication à un magasin, déconnectez-la ici en définissant site sur cette plateforme de publication, puis faites-lui suivre à nouveau l’URL de connexion (ou exécutez trigger-matches et Connecter une fiche) pour associer la bonne fiche. La déconnexion laisse l’établissement et ses données intacts ; seule la synchronisation sortante vers cette plateforme de publication s’arrête.
Cas d’utilisation : un client part et emporte son compte Apple Business
Avec site: "APPLE", l’établissement cesse d’être publié via le compte Apple Business du propriétaire. Il reste sur Apple Maps : les mises à jour ultérieures sont publiées via le compte Apple Business Connect de ListingsAPI, et Apple vérifie la soumission avant de la publier. Pour publier à nouveau via le compte du propriétaire, envoyez-lui un nouveau lien provenant de Créer une URL de connexion OAuth pour un établissement.
Ce point de terminaison modifie une connexion active. La requête et la réponse présentées ci-dessus sont des exemples.
curl -X POST 'https://listingsapi.com/api/v4/locations/oauth-disconnect' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" } }'