Synup
Créer une clé
v1Ressources/Connexions/getObtenir une URL de connexion Apple

Obtenir une URL de connexion Apple

Renvoie une URL d'autorisation Apple Business Connect à ouvrir dans un navigateur. Accepte locationId ou clientId, au moins l'un des deux ; lorsque locationId est fourni, la fiche est liée côté serveur, sans étape de sélection.

get/api/v1/connections/apple/connect-url
connections:write
Paramètres de requête
locationIdstringfacultatif
L'emplacement à connecter. Facultatif pour Apple : indiquez locationId ou clientId, au moins l'un des deux.
clientIdstringfacultatif
Le client de l'emplacement. Nécessaire uniquement pour lever une ambiguïté lorsque votre clé est limitée à des clients spécifiques.
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/apple/connect-url
Votre clé API
locationId
clientId
successUrl
errorUrl
{
  "data": {
    "provider": "apple",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://businessconnect.apple.com/authorize?client_id=...&redirect_uri=...&scope=...&state=...",
    "successUrl": null,
    "errorUrl": null,
    "note": "Open this URL in a browser under the account owner's control. Apple's account represents the business itself, so with a locationId supplied the listing binds server-side with no picker step. There is no callback; poll GET /api/v1/connections, or pass successUrl and errorUrl to get a one-time code back."
  }
}

Guides qui utilisent cette ressource