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

Google-Verbindungs-URL abrufen

Gibt eine Google-OAuth-Autorisierungs-URL zurück, die in einem Browser geöffnet wird, um das Google-Unternehmensprofil dieses Standorts zu verbinden. Dieser Endpunkt kann die Verbindung nicht selbst abschließen — der Google-Zustimmungsbildschirm erfordert einen interaktiven Menschen.

get/api/v1/connections/google/connect-url
connections:write
Query-Parameter
locationIdstringerforderlich
Der zu verbindende Standort.
clientIdstringoptional
Der Kunde des Standorts. Nur zur Eindeutigkeit nötig, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
returnUrlstringoptional
App-interner Pfad, auf dem nach Abschluss des Zustimmungsbildschirms gelandet wird. Standard: "/".
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/google/connect-url
Ihr API-Schlüssel
locationId *
clientId
returnUrl
successUrl
errorUrl
{
  "data": {
    "provider": "google",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
    "successUrl": "https://app.example.com/oauth/done",
    "errorUrl": "https://app.example.com/oauth/failed",
    "note": "Open this URL in a browser under the account owner's control. When the connect settles, the browser is sent to your successUrl (with ?code=...&status=...&connected_account_id=...) or errorUrl (with ?error=...). Exchange the code server-side at POST /api/v1/connections/handoff/exchange within 10 minutes for the connection id and the email that authorised."
  }
}

Anleitungen, die diesen Endpunkt verwenden