Synup
Schlüssel erstellen
v1Ressourcen/Connections/getApple-Verbindungs-URL abrufen

Apple-Verbindungs-URL abrufen

Gibt eine Apple-Business-Connect-Autorisierungs-URL zurück, die in einem Browser geöffnet wird. Akzeptiert locationId oder clientId, mindestens eines; wird locationId angegeben, wird der Eintrag serverseitig ohne Auswahlschritt verknüpft.

get/api/v1/connections/apple/connect-url
connections:write
Query-Parameter
locationIdstringoptional
Der zu verbindende Standort. Optional für Apple: Geben Sie locationId oder clientId an, mindestens eines.
clientIdstringoptional
Der Kunde des Standorts. Nur zur Eindeutigkeit nötig, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
successUrlstringoptional
Wohin der Browser des Kunden nach einer erfolgreichen Verbindung gesendet wird. Muss auf dem API-Schlüssel registriert und zusammen mit errorUrl angegeben werden.
errorUrlstringoptional
Wohin der Browser gesendet wird, wenn die Verbindung fehlschlägt oder abgebrochen wird. Gleiche Registrierungsregel, zusammen mit successUrl angegeben.
Antwort
dataobjectoptional
providerstring (google | facebook | apple)optional
Welcher Publisher mit dieser URL verbunden wird: google, facebook oder apple.
locationIdstringoptional
Der Standort, dem diese Verbindung zugeordnet wird, oder null, wenn die Verbindung mit einer clientId gestartet wurde.
clientIdstringoptional
Der Kunde, auf den diese Verbindung beschränkt ist, oder null.
urlstringoptional
Die Autorisierungs-URL — in einem Browser unter Kontrolle des Kontoinhabers öffnen.
successUrlstringoptional
Die für diesen Aufruf verwendete successUrl, oder null im Legacy-Modus.
errorUrlstringoptional
Die für diesen Aufruf verwendete errorUrl, oder null im Legacy-Modus.
notestringoptional
Hinweise zum Öffnen der URL. Erklärt die Partner-Übergabe, wenn successUrl und errorUrl gesetzt sind, andernfalls den Abfrage-Ablauf über GET /api/v1/connections.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/apple/connect-url
Ihr API-Schlüssel
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."
  }
}

Anleitungen, die diese Ressource verwenden