/api/v4/locations/oauth_connect_urlConnecter un établissement à Apple Business Connect
Crée un lien OAuth Apple Business Connect : ListingsAPI publie l’établissement sur Apple Maps via le compte Apple Business vérifié du propriétaire.
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 | Location to connect. Accepts a Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
| input.site | string | obligatoire | Set to `APPLE`. |
| input.successUrl | string | obligatoire | Absolute URL in your application the owner returns to after granting access. |
| input.errorUrl | string | obligatoire | Absolute URL in your application the owner returns to if they cancel or the grant fails. |
Exemple de requête
Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "APPLE", "successUrl": "https://app.example.com/locations/1800289/apple/connected", "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed" }}Réponses
200A single-use link to send the owner to. `errors` is `null` on success. The `url` shown is a placeholder; send the owner to the `url` returned in your own response.
{ "data": { "createConnectUrl": { "success": true, "url": "https://connect.example.com/oauth?token=8f3c1d92-...", "errors": null } }}401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to connect this location (`SY90003`).
Utilisez cette fonctionnalité lorsque le propriétaire de l'entreprise dispose d'un compte d'organisation Apple Business vérifié. Dirigez le propriétaire vers url ; il se connecte à Apple Business Connect, autorise l'accès et revient à votre successUrl. Dès lors, ListingsAPI publie le nom, la catégorie, l'adresse, le numéro de téléphone, le site web et les horaires de cet établissement sur Apple Maps via le compte du propriétaire. S'il annule ou si l'autorisation échoue, il revient à errorUrl et aucune connexion n'est établie.
Si le propriétaire ne dispose pas d'un compte d'organisation Apple Business vérifié, ignorez cet appel. ListingsAPI publie l'établissement via son propre compte Apple Business Connect, et Apple vérifie la soumission avant de la publier.
Apple connecte un seul établissement par lien. Pour connecter plusieurs établissements, créez un lien pour chacun d'eux. Les deux URL de redirection doivent être absolues ; une valeur relative ou impossible à analyser est renvoyée sous la forme success: true avec un null url, alors vérifiez url avant de rediriger. Le lien est à usage unique : créez-en donc un nouveau à chaque tentative.
Confirmer la connexion
Une fois le propriétaire revenu à successUrl, appelez Lister les comptes connectés avec publisher=AppleAccount. Une valeur CONNECTED pour status signifie que les mises à jour passent par le compte du propriétaire. MATCH_IN_PROGRESS ou CONNECTIVITY_ISSUE signifie que le propriétaire doit ouvrir un nouveau lien de connexion.
Pour cesser de publier via le compte du propriétaire, utilisez Déconnecter un établissement d'Apple Business Connect. Pour connaître la procédure complète, y compris la vérification de la fiche Apple Maps, consultez Connecter Apple Business Connect.
Cette page documente le cas site: "APPLE" de Créer une URL de connexion OAuth pour un établissement.
Cet endpoint crée des identifiants OAuth actifs. 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_connect_url' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "APPLE", "successUrl": "https://app.example.com/locations/1800289/apple/connected", "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed" } }'