Skip to main content
Ihre Nutzer verbinden ihre eigenen Social-Media-Konten selbst — sie authentifizieren sich direkt bei jedem Netzwerk, und Sie sehen oder speichern nie deren Zugangsdaten. Auf dieser Seite geht es darum, sie zu diesem Moment zu bringen und zu erfahren, wie es ausgegangen ist. Eines ist allen Wegen gemeinsam: eine Link Session, erstellt mit Eine Link Session erstellen aus Ihrem API Key und einem Profile-Key. Auf Ihrer Seite wird nichts signiert, und es ist kein Private Key im Spiel.

Drei Wege zum Verbinden

Drei Varianten, und die ersten beiden sind dieselbe Integration. Wählen Sie pro Ablauf — sie schließen sich nicht aus, und viele Integrationen verwenden die gehostete Seite für das Onboarding und danach das Widget innerhalb der App.
Die beiden Widget-Zeilen sind eine Integration, nicht zwei. Ein einziges init gibt Ihnen beides: Mounten Sie Frames dort, wo Sie unsere Schaltflächen möchten, und rufen Sie überall sonst popup() aus Ihrer eigenen Schaltfläche auf. Beide teilen sich eine Session und melden sich über dieselben Handler.Direct Mode ist dasselbe Popup ohne unser Skript — für eine Seite mit strikter Content-Security-Policy, eine servergerenderte Seite oder eine native App. Dort öffnen und überwachen Sie das Popup selbst.Nicht sicher? Beginnen Sie mit der gehosteten Verknüpfungsseite. Sie benötigt keinen Max Pack und keine zusätzlichen Parameter und ist der schnellste Weg zu etwas Funktionierendem — ein späterer Wechsel zum Widget ändert nichts daran, wie Sessions erstellt werden.
Rufen Sie Eine Link Session erstellen mit dem Profile-Key des Nutzers im Header auf. Für die gehostete Seite ist das die gesamte Anfrage:
cURL
Sie erhalten eine url zurück, die ein kurzlebiges, opakes Token trägt:
Linking URL
Sie können außerdem prüfen, ob ein Link geöffnet wurde, und ihn widerrufen, bevor er abläuft.
Dieses einminütige Video zeigt, wie ein Link erstellt wird. Es wurde vor den Link Sessions aufgenommen und zeigt daher noch, wie ein Private Key gesendet wird — dieser Schritt ist nicht mehr erforderlich, alles andere im Video ist unverändert.

Die Linking-URL versenden

Eine Linking-URL meldet Ihren Nutzer in seinem Profil an — behandeln Sie sie wie ein Passwort. Versenden Sie sie über einen vertrauenswürdigen Kanal, loggen Sie sie nicht und geben Sie sie nicht an Dritte weiter. Sie bleibt für ihr gesamtes Zeitfenster nutzbar, ein Reload oder ein OAuth-Retry funktioniert also — senden Sie jeden Link aber nur an einen Nutzer und erstellen Sie pro Person einen eigenen Link.

Die Linking-URL öffnen

Öffnen Sie sie in einem neuen Browser-Tab, einem neuen Fenster oder einem View Controller. Sie können das Schließen oder Umleiten dieses Fensters steuern.
Die sozialen Netzwerke erlauben es nicht, die gehostete Verknüpfungsseite in einem iFrame zu öffnen oder die freigegebene Partner-Ursprungsdomain profile.ayrshare.com zu verschleiern. Wenn die Verknüpfung innerhalb Ihrer eigenen Seite stattfinden soll, ist genau dafür das eingebettete Widget da: Seine Frames werden von einer Ayrshare-Origin ausgeliefert und sind der unterstützte Weg dafür.

Erfahren, wann es abgeschlossen ist

Zwei Signale, und Sie können jedes davon nutzen:
  • Link-Completion-Events — setzen Sie beim Erstellen des Links ein origin, und das Verknüpfungsfenster sendet connect:success, connect:error und connect:cancelled an Ihre Seite, sobald sie eintreten. Kein Polling.
  • Eine Link Session abrufen — meldet completedAt, lastCompletedAt und completedNetworks. Das ist das Signal für native Apps und das einzige für Telegram, das außerhalb des Browsers abgeschlossen wird.

Link-Gültigkeit

Ein Link ist standardmäßig 5 Minuten gültig. Danach erstellen Sie einen neuen. Mit dem Max Pack setzen Sie expiresIn in Minuten, um dieses Zeitfenster zu erweitern — bis zu 2880 Minuten (48 Stunden), dem Maximum, das die API akzeptiert:
Expires In
Ein längeres Zeitfenster macht das Versenden des Links per E-Mail erst praktikabel — ein Nutzer, der ein getrenntes Konto neu verknüpft, kann direkt aus Ihrer E-Mail zum Netzwerk gehen, ohne zuerst Ihre App zu besuchen.
Prüfen Sie mit Ihrem Sicherheitsteam, wie lange ein Link gültig bleiben soll. Ein längeres Zeitfenster ist ein längerer Zeitraum, in dem ein abgefangener Link noch funktioniert. Gerät einer nach außen, können Sie ihn widerrufen, statt auf seinen Ablauf zu warten.

Profile Key

Der Profile-Key gibt an, für welches User Profile der Link gilt. Sie finden ihn im Ayrshare-Entwickler-Dashboard, indem Sie zu diesem Profil wechseln.
Der Private Key wird nicht mehr verwendet. Links werden nicht signiert, es gibt also nichts, was aus einer Datei gelesen oder in Ihren Code eingefügt werden müsste. Der Legacy-Parameter privateKey wird weiterhin akzeptiert und ignoriert, sodass bestehende Integrationen weiterlaufen, und die Datei private.key in Ihrem Integration Package kann ungenutzt bleiben.

Profile wechseln

Wenn ein Profil bereits angemeldet ist, wechselt das Öffnen des Links eines anderen Profils nicht das Profil — das ist beabsichtigt und hält die Nutzung für einen bereits angemeldeten Nutzer schnell. Um einen Wechsel zu erzwingen, siehe Automatische Abmeldung einer Profilsitzung. Instagram-Konten können auf zwei Arten verknüpft werden: direkt mit Instagram Login oder über eine verbundene Facebook-Seite. Welcher Ablauf startet, wenn ein Nutzer auf die Instagram-Schaltfläche klickt, wird normalerweise durch die kontoweite Einstellung Instagram Login gesteuert. Der Body-Parameter instagramLinkMethod überschreibt diese Einstellung für einen einzelnen Link:
Instagram Link Method
Die Überschreibung gilt für die Lebensdauer dieses Links, einschließlich der Autorisierungsweiterleitung von Instagram/Facebook. Einige Punkte, die Sie wissen sollten:
  • Sie ändert nicht Ihre kontoweite Einstellung und beeinflusst keinen anderen Link.
  • Lassen Sie sie weg, gilt die kontoweite Einstellung, genau wie zuvor.
  • Ein ungültiger Wert gibt 400 zurück und listet die gültigen Werte auf (instagram, facebook).
  • Prüfen Sie die Funktionsunterschiede, bevor Sie wählen — einige Instagram-Funktionen wie Hashtag-Suche und Kollaborationen sind nur mit der Facebook-Seiten-Authentifizierung verfügbar.

Connect-Accounts-E-Mail

Ayrshare kann den Link für Sie per E-Mail an Ihren Nutzer senden, damit er seine Verknüpfungsseite erreichen kann, ohne Ihre App zu besuchen. Kombinieren Sie das mit einem längeren expiresIn — die standardmäßigen fünf Minuten überstehen selten ein Postfach.

Connect Accounts JSON

Jedes Feld innerhalb von email ist erforderlich. Fehlt eines, schlägt der Versand fehl.
Example Contact Email Request
expiresIn ist ein Parameter auf oberster Ebene, nicht Teil des email-Objekts. Innerhalb von email verschachtelt wird es ignoriert, und Ihr Nutzer erhält einen Link, der in fünf Minuten abläuft.
Die Antwort meldet das Ergebnis in emailSent:
Example Contact Email Response
Ein Sendefehler kommt nicht als emailSent: false zurück — er gibt stattdessen code: 333 zurück. false bedeutet also, dass keine E-Mail angefordert wurde.

Beispiel für eine Connect-Accounts-E-Mail

Hier ein Beispiel der E-Mail, die die Social-Verknüpfungsseite öffnet: Connect Accounts email Die E-Mail wird von der folgenden Adresse gesendet: Social Connect Hub <connect@socialconnecthub.com>

Mobile Apps

Öffnen Sie die Linking-URL im Systembrowser, nie in einer eingebetteten WebView: Google lehnt die Anmeldung darin mit disallowed_useragent ab, und Meta blockiert sie vollständig. Ihr Nutzer würde die Fehlerseite des Netzwerks sehen, und nichts auf Ihrer Seite kann das beheben.
  • iOSASWebAuthenticationSession oder SFSafariViewController.
  • Android — Chrome Custom Tabs.
Da eine native App kein Browserfenster hat, an das Events gesendet werden könnten, holen Sie sich das Ergebnis stattdessen über Eine Link Session abrufen. Setzen Sie origin auf Ihr eigenes Custom Scheme (myapp://connected), damit die Seite einen Rückweg in Ihre App hat.

Mobile-Codebeispiele

Ersetzen Sie linkingURL durch die url, die Eine Link Session erstellen zurückgibt.

Testen

Es wird empfohlen, einen Link zunächst in Postman zu erstellen. Ihr Integration Package — auf der API-Key-Seite des Primary Profile im Dashboard — enthält eine Beispiel-Postman-Konfiguration. Importieren Sie sie, tragen Sie Ihren Profile Key im Body-Feld profileKey ein und klicken Sie auf Send. Die Beispielkonfiguration füllt privateKey und domain weiterhin vor. privateKey wird ignoriert, und domain können Sie leeren, sofern Ihr Account nicht mehr als eine Linking-Domain hat. Sie können auch den Code aus Postman generieren.

Bubble.io

Bubble linking URL

Legacy: generateJWT

Linking-URL erzeugen (generateJWT) erledigt dieselbe Aufgabe und ist veraltet (deprecated) — vollständig unterstützt, ohne Abschaltdatum und unverändert für Links, die Sie bereits herausgegeben haben. Die eigene Seite des Endpunkts dokumentiert seine Parameter, einschließlich der drei, die inzwischen akzeptiert und ignoriert werden.Beide Endpunkte nutzen denselben Validator, sodass alles auf dieser Seite für beide gilt. Der eine Unterschied, den Sie bei der Migration kennen sollten: generateJWT toleriert drei Dinge, die Eine Link Session erstellen ablehnt — ein unbekanntes allowedSocial-Netzwerk, eine einzelne X-Zugangsdaten-Hälfte und ein nicht-String-redirect.