Synup
Schlüssel erstellen
v1Ressourcen/Connections/postEinen Verbindungs-Übergabecode einlösen

Einen Verbindungs-Übergabecode einlösen

Löst den Einwegcode ein, der an Ihre successUrl übermittelt wurde. Gibt die Verbindungs-ID und die E-Mail-Adresse zurück, die die Verbindung autorisiert hat. Lösen Sie ihn serverseitig innerhalb von 10 Minuten ein; der Code ist einmalig verwendbar.

post/api/v1/connections/handoff/exchange
connections:read
Anfragetext
codestringerforderlich
Der Einmalcode aus der Weiterleitung an successUrl. Einmalig verwendbar, läuft 10 Minuten nach Ausstellung ab.
Antwort
dataobjectoptional
statusstring (connected | connected_no_listing | error)optional
Wie die Verbindung abgeschlossen wurde: connected, connected_no_listing oder error.
platformstring (google | facebook | apple)optional
Welcher Publisher verbunden wurde: google, facebook oder apple.
connectionIdstringoptional
Die Verbindungs-ID. Dieselbe ID, die GET /api/v1/connections auflistet und die POST /api/v1/connections/fetch-listings akzeptiert.
connectedAccountIdstringoptional
Identisch mit connectionId, unter dem Namen, den manche Integrationen erwarten. Beide sind derselbe Wert.
boundConnectionIdstringoptional
Die Verbindung auf Standortebene, wenn ein Eintrag verknüpft wurde, oder null.
locationIdstringoptional
Der Standort, für den diese Verbindung galt, oder null.
clientIdstringoptional
Der Kunde, auf den diese Verbindung beschränkt war, oder null.
emailstringoptional
Die E-Mail-Adresse, die die Verbindung autorisiert hat, oder null.
errorstringoptional
Der Fehlercode, wenn status error ist, oder null.
connectedAtstringoptional
Wann die Verbindung abgeschlossen wurde, als ISO-8601-Zeitstempel.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
410Der Code wurde bereits verwendet oder ist abgelaufen. Der Antworttext enthält den Grund, "used" oder "expired".
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/handoff/exchange
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "status": "connected",
    "platform": "google",
    "connectionId": "conn_789",
    "connectedAccountId": "conn_789",
    "boundConnectionId": "conn_456",
    "locationId": "loc_456",
    "clientId": null,
    "email": "owner@grovestreetdental.com",
    "error": null,
    "connectedAt": "2026-09-17T10:00:00.000Z"
  }
}

Anleitungen, die diesen Endpunkt verwenden