Skip to main content
POST
Erstellen Sie eine Social-Linking-URL für ein User Profile. Senden Sie die zurückgegebene url an Ihren Nutzer; er öffnet sie, um seine Social-Media-Konten zu verbinden. Dies ist der empfohlene Weg, eine Linking-URL zu erstellen. Es werden nur Ihr API Key und ein Profile-Key benötigt — es gibt keinen Private Key zu senden und nichts zu signieren. Anders als eine bisher erstellte Linking-URL wird eine Link Session gespeichert, sodass Sie prüfen können, ob sie verwendet wurde, und sie widerrufen können, bevor sie abläuft. Die zurückgegebene url meldet Ihren Nutzer in seinem Profil an — behandeln Sie sie daher wie ein Passwort und senden Sie jede nur an einen einzelnen Nutzer. Siehe Die Linking-URL versenden.
Die URL ist standardmäßig 5 Minuten gültig. Verwenden Sie expiresIn, um ein anderes Zeitfenster festzulegen, bis zu 2880 Minuten (48 Stunden).
Linking-URL erzeugen führt denselben Vorgang aus und funktioniert unverändert weiter. Er akzeptiert die Legacy-Parameter privateKey, base64 und verify und ignoriert sie. domain wird auf keinem der beiden Endpunkte ignoriert — es bleibt optional und wird weiterhin validiert. Neue Integrationen sollten diesen Endpunkt verwenden.Ein Unterschied in der Antwort: generateJWT gibt aus Gründen der Abwärtskompatibilität ein token auf oberster Ebene zurück, und dieser Endpunkt gibt keines neben einer url zurück — das Token einer url steckt in ihr. Wenn Sie migrieren und Ihr Code token liest, lesen Sie stattdessen url. (Der Connect Mode für das eingebettete Widget ist die eine Form, die ein reines token zurückgibt, weil sie keine URL zurückgibt, in der das Token stecken könnte.)

Header-Parameter

Der Profile-Key ist auf diesem Endpunkt ein Header — es gibt keinen Body-Parameter profileKey. Fehlt er, erhalten Sie code: 188, dessen Meldung privateKey, profileKey und andere Legacy-Feldnamen auflistet, weil sie mit Linking-URL erzeugen geteilt wird. Lesen Sie sie als „der Profile-Key-Header fehlt oder ist falsch“; keiner der anderen darin genannten Namen ist ein Parameter dieses Endpunkts.
string
Ihr X-API-Key (Consumer Key) aus dem X Developer Portal. Wenn angegeben, verwendet die Linking-URL Ihre eigene X Developer App für die OAuth-Verknüpfung.
string
Ihr X-API-Secret (Consumer Secret) aus dem X Developer Portal. Erforderlich, wenn X-Twitter-OAuth1-Api-Key angegeben ist.

Body-Parameter

string
Standard:"grid"
Welche Verknüpfungsoberfläche diese Session bedient.
  • grid — die gehostete Verknüpfungsseite, die jedes von Ihnen erlaubte Netzwerk zeigt. Das ist der Standard, eine Anfrage ohne mode erstellt also eine solche Session.
  • connect — ein Netzwerk nach dem anderen, geöffnet aus Ihrem eigenen Dashboard. Siehe Connect Mode unten und Direct Mode.
Wird nie abgeleitet: Das Übergeben von origin oder network versetzt Sie nicht in den Connect Mode, eine Grid-Session kann also nicht versehentlich zu einer zugangsbeschränkten werden. Jeder andere Wert gibt code: 188 zurück, wobei details die beiden gültigen benennt.
number
Standard:5
Gültigkeitsdauer des Links in Minuten. Bereich: 1 bis 2880 Minuten.Erfordert das Max Pack.Weitere Informationen finden Sie unter Link-Gültigkeit.
boolean
Standard:false
Automatisches Abmelden der aktuellen Sitzung. Wird in der Produktion nicht empfohlen, da dies die Performance beeinflusst.Siehe Automatische Abmeldung einer Profilsitzung.
string
Eine URL, zu der weitergeleitet wird, wenn die Schaltfläche „Done“ (Fertig) oder das Logo angeklickt wird. Fügen Sie den Query-Parameter origin=true hinzu, um das Öffnerfenster weiterzuleiten.
array
Die auf der Verknüpfungsseite anzuzeigenden sozialen Netzwerke. Überschreibt die auf der Seite Soziale Netzwerke konfigurierten Netzwerke.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
string
Nur Connect Mode. Das einzelne soziale Netzwerk, das diese Session verbindet — genau das macht sie zu einer Direct-Mode-Session. Lassen Sie es weg für eine Session, die Ihr eigenes Dashboard über mehrere Netzwerke hinweg bedient.Eines von bluesky, facebook, gmb, instagram, instagramApi, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, whatsapp, x, youtube. Alles andere gibt code: 508 zurück — einschließlich fbg, das hier kein Verknüpfungsziel ist.Kann nicht mit allowedSocial kombiniert werden (code: 507): Eine Session für ein einzelnes Netzwerk ist bereits ihre eigene Allowlist. Ein Netzwerk, das Ihr Account nicht aktiviert hat, gibt code: 509 zurück — bewusst eine andere Antwort als 508, weil Sie das auf Ihrer Seite Soziale Netzwerke selbst beheben können.Im Grid Mode wird es ignoriert.
Überschreibt, welcher Instagram-Verknüpfungsablauf für diesen Link verwendet wird. Gültige Werte:
  • instagram: Direktes Instagram Login, keine Facebook-Seite erforderlich.
  • facebook: Instagram über eine verbundene Facebook-Seite verknüpfen.
Wenn weggelassen, verwendet die Verknüpfungsseite Ihre kontoweite Instagram-Login-Einstellung.
string
Die exakte Origin der Seite, die das Verknüpfungsfenster geöffnet hat, damit ihr mitgeteilt werden kann, wann die Verknüpfung abgeschlossen ist.Wenn gesetzt, sendet die Verknüpfungsseite mit window.postMessage Events an diese Origin, während Ihr Nutzer die Konten verbindet, und Ihre Seite kann ohne Polling reagieren. Events werden ausschließlich an genau diesen Wert gesendet — er muss also Zeichen für Zeichen der Origin Ihrer Seite entsprechen, einschließlich Schema und eventuellem Port.Drei Formen werden akzeptiert: eine https-Origin (https://app.example.com), http://localhost:3000 für die lokale Entwicklung und ein natives Custom Scheme (myapp://connected). Alles andere — eine reine http://-Origin außer localhost oder etwas, das gar keine Origin ist — wird auf den Links, die dieser Endpunkt erstellt, ignoriert: Der Link funktioniert weiterhin, er sendet nur keine Events. Der Parameter ist optional, das Weglassen ist also ebenfalls kein Fehler.Von den dreien empfangen nur die ersten beiden Events. Ein Custom Scheme ist ein Rücksprungziel für eine mobile App und kann keine empfangen, weil es kein Browserfenster gibt, an das gesendet werden könnte; native Apps pollen stattdessen Eine Link Session abrufen.Siehe Link-Completion-Events.Im Connect Mode ist origin erforderlich, und es wird geprüft. Die Nachsicht oben ist Grid-Mode-Verhalten. Mit mode: "connect" gibt das Weglassen code: 505 zurück, und ein Wert, der keiner der drei akzeptierten Formen entspricht, gibt code: 506 zurück, dessen details die gesendete Form wiederholen.
string
Optional. Ihre Linking-Domain, wenn Ihr Account mehr als eine hat. Wird die Angabe weggelassen, wird die eigene Domain Ihres Accounts verwendet. Eine nicht für Ihren Account registrierte Domain wird abgelehnt.
object
Senden Sie eine Connect-Accounts-E-Mail mit dem Link, damit Ihr Nutzer seine Verknüpfungsseite direkt erreichen kann. Erfordert eine to-Adresse.Erfordert das Max Pack. Die Antwort meldet das Ergebnis in emailSent, und ein Sendefehler gibt code: 333 statt einer Erfolgsantwort zurück.Siehe Connect-Accounts-E-Mail.

Connect Mode

mode: "connect" erstellt eine Session für eine Verknüpfungsoberfläche, die Sie selbst hosten, statt für die gehostete Verknüpfungsseite. Welche der beiden Connect-Formen Sie erhalten, hängt von einer Sache ab — ob Sie network übergeben:
Die Antwort trägt das Geheimnis genau einmal. Eine Antwort hat entweder eine url oder ein token, nie beides und nie zwei URLs. Das Token einer Direct-Mode-Session steckt in der url, genau wie im Grid Mode; eine Session ohne URL, die es tragen könnte, gibt stattdessen das reine token zurück. Alles andere ist in allen drei Modi gleich: sessionId, expiresAt, emailSent und title, wenn das User Profile einen hat.

Was Connect Mode erfordert

Keines von beiden ist ein eigenes Body-Feld — das erste ist eine Account-Berechtigung und das zweite der origin-Parameter oben, den der Connect Mode verpflichtend macht. Der Max Pack. Ohne ihn gibt der Aufruf code: 504 zurück, geprüft vor den Connect-Mode-Parametern — das Korrigieren von origin oder network ändert die Antwort also nicht. Kontaktieren Sie den Support, wenn Sie den Connect Mode auf einem Account ohne Max Pack aktivieren müssen. Ein origin, auf jeder Session. Es gibt keine Allowlist und keinen Registrierungsschritt — Sie senden ihn bei jedem Aufruf, und er wird auf der Session gespeichert, eine neue Umgebung braucht also keine Einrichtung auf unserer Seite. Drei Formen werden akzeptiert:
  • eine https-Origin — https://app.example.com
  • ein natives Custom Scheme — myapp://connected
  • http://localhost oder http://localhost:3000, für die lokale Entwicklung
Nur die Origin: kein Pfad, keine Query, kein Fragment und keine Zugangsdaten darin. Das Weglassen gibt code: 505 zurück, und alles, was keine der drei Formen ist, gibt code: 506 zurück.
email kann nicht mit einer Session ohne network verwendet werden, weil es keinen Link gibt, der in die E-Mail könnte — diese Form gibt ein Token für Ihr eigenes Frontend zurück. Der Aufruf gibt code: 510 zurück. Fügen Sie ein network für eine Direct-Mode-Session hinzu, die eine URL hat, oder lassen Sie email weg.
Jeder oben genannte Code steht in der Referenz Link-Session-Fehler.