Zum Hauptinhalt springen
POST
Erzeugen Sie ein JSON Web Token (JWT) zur Verwendung mit Single Sign-On. Weitere Details finden Sie in der Übersicht zur JWT-Generierung.
Die JWT-URL ist 5 Minuten gültig. Nach 5 Minuten müssen Sie eine neue JWT-URL erzeugen. Weitere Optionen für den Max Pack expiresIn finden Sie hier.

Header-Parameter

X-Twitter-OAuth1-Api-Key
string
Ihr X-API-Key (Consumer Key) aus dem X Developer Portal. Alternative zum Body-Parameter twitterApiKey. Wenn angegeben, verwendet die generierte JWT-URL Ihre X Developer App für die OAuth-Verknüpfung.
X-Twitter-OAuth1-Api-Secret
string
Ihr X-API-Secret (Consumer Secret) aus dem X Developer Portal. Alternative zum Body-Parameter twitterApiSecret. Erforderlich, wenn X-Twitter-OAuth1-Api-Key angegeben ist.
Empfohlen: Übergeben Sie Ihre X-Anmeldeinformationen über Header (X-Twitter-OAuth1-Api-Key und X-Twitter-OAuth1-Api-Secret), um Konsistenz mit allen anderen Ayrshare-API-Endpunkten sicherzustellen. Die Body-Parameter twitterApiKey und twitterApiSecret werden aus Gründen der Abwärtskompatibilität weiterhin unterstützt.

Body-Parameter

domain
string
erforderlich
Domain der App. Bitte verwenden Sie genau die während des Onboardings vergebene Domain.
privateKey
string
erforderlich
Für die Verschlüsselung verwendeter Private Key.
profileKey
string
erforderlich
User Profile Key. Der API Key kann in diesem Feld nicht verwendet werden.
logout
boolean
Standard:false
Automatisches Abmelden der aktuellen Sitzung. Wird in der Produktion nicht empfohlen, da dies die Performance beeinflusst.Weitere Informationen finden Sie unter Automatische Abmeldung einer Profilsitzung.
redirect
string
Geben Sie eine URL an, zu der weitergeleitet werden soll, wenn die Schaltfläche „Done“ oder das Logo angeklickt wird. Die URL wird in der zurückgegebenen JWT-URL automatisch gekürzt. Weiterleitung des Origin-Öffnerfensters durch Hinzufügen des Query-Parameters origin=true zur Weiterleitungs-URL.
allowedSocial
array
Geben Sie die auf der Verknüpfungsseite anzuzeigenden sozialen Netzwerke an. Dies überschreibt die auf der Seite Soziale Netzwerke konfigurierten Netzwerke.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
Überschreibt, welcher Instagram-Verknüpfungsablauf verwendet wird, wenn ein Nutzer auf der Social-Verknüpfungsseite für diese URL auf die Instagram-Schaltfläche klickt. Gültige Werte:
  • instagram: Direktes Instagram Login, keine Facebook-Seite erforderlich.
  • facebook: Instagram über eine verbundene Facebook-Seite verknüpfen.
Force direct Instagram Login for this linking session
Wenn weggelassen, verwendet die Verknüpfungsseite Ihre kontoweite Instagram-Login-Einstellung.Weitere Informationen finden Sie unter Instagram-Verknüpfungsmethode.
verify
boolean
Standard:false
Überprüfen, ob das generierte Token gültig ist. Empfohlen wird die Verwendung nur in einer Nicht-Produktionsumgebung.Weitere Informationen finden Sie unter Opening and Closing the Social Linking URL.
base64
boolean
Standard:false
Wenn der Private Key base64-kodiert ist, auf true setzen.Kodieren Sie die Datei private.key in base64 und übergeben Sie den einzeiligen String im Feld privateKey.Z. B. in Linux: cat private.key | base64
expiresIn
number
Standard:5
Legen Sie die Gültigkeitsdauer des Tokens in Minuten fest. Bereich: 1 Minute bis 2880 Minuten.Weitere Informationen finden Sie unter JWT Expires In.
email
object
Standard:5
Senden Sie eine Connect-Accounts-E-Mail mit einem Link, über den Nutzer direkt auf ihre Social-Verknüpfungsseite zugreifen können.Weitere Informationen finden Sie unter Connect-Accounts-E-Mail.
Wenn Sie Ihre X-API-Anmeldeinformationen angeben, initiiert die generierte JWT-URL die OAuth-Verknüpfung mit Ihrer eigenen X Developer App. Ihre Endnutzer sehen auf dem X-Zustimmungsbildschirm den Namen Ihrer App.
Erforderlich: Bevor Sie diese Funktion verwenden, müssen Sie diese Callback-URLs zu den Einstellungen Ihrer X Developer App hinzufügen (unter Authentication settings > Callback URI / Redirect URL):
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
Ohne diese schlägt der OAuth-Ablauf mit dem Fehler 403 Callback URL not approved fehl.