Passer au contenu principal
POST
Générez un JSON Web Token (JWT) à utiliser avec l’authentification unique (SSO). Consultez la Vue d’ensemble de Generate JWT pour plus de détails.
L’URL JWT est valide pendant 5 minutes. Après 5 minutes, vous devez générer une nouvelle URL JWT. Consultez le Max Pack expiresIn pour des options supplémentaires.

Paramètres d’en-tête

X-Twitter-OAuth1-Api-Key
string
Votre clé API X (Consumer Key) provenant du portail développeur X. Alternative au paramètre de corps twitterApiKey. Lorsqu’elle est fournie, l’URL JWT générée utilisera votre application développeur X pour la liaison OAuth.
X-Twitter-OAuth1-Api-Secret
string
Votre secret API X (Consumer Secret) provenant du portail développeur X. Alternative au paramètre de corps twitterApiSecret. Requis lorsque X-Twitter-OAuth1-Api-Key est fourni.
Recommandé : transmettez vos identifiants X via les en-têtes (X-Twitter-OAuth1-Api-Key et X-Twitter-OAuth1-Api-Secret) pour la cohérence avec tous les autres points de terminaison de l’API Ayrshare. Les paramètres de corps twitterApiKey et twitterApiSecret sont toujours pris en charge pour la rétrocompatibilité.

Paramètres du corps

domain
string
requis
Domaine de l’application. Veuillez utiliser le domaine exact fourni lors de l’intégration.
privateKey
string
requis
Clé privée utilisée pour le chiffrement.
profileKey
string
requis
Clé de profil d’utilisateur. La clé API ne peut pas être utilisée dans ce champ.
logout
boolean
défaut:false
Déconnecte automatiquement la session en cours. Il est recommandé de ne pas l’utiliser en production, car cela affecte les performances.Consultez Déconnexion automatique d’une session de profil pour plus d’informations.
redirect
string
Spécifiez une URL vers laquelle rediriger lorsque le bouton « Done » ou l’image du logo est cliqué. L’URL sera automatiquement raccourcie dans l’URL JWT retournée. Redirigez la fenêtre d’ouverture d’origine en ajoutant le paramètre de requête origin=true à l’URL de redirection.
allowedSocial
array
Spécifiez les réseaux sociaux à afficher sur la page de liaison. Cela remplacera les réseaux sociaux configurés dans la page Réseaux sociaux.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
Remplacez le flux de liaison Instagram utilisé lorsqu’un utilisateur clique sur le bouton Instagram sur la page de liaison sociale pour cette URL. Valeurs valides :
  • instagram : Instagram Login direct, aucune page Facebook requise.
  • facebook : lier Instagram via une page Facebook connectée.
Force direct Instagram Login for this linking session
Lorsqu’omis, la page de liaison utilise votre paramètre Instagram Login à l’échelle du compte.Consultez Méthode de liaison Instagram pour plus d’informations.
verify
boolean
défaut:false
Vérifiez que le token généré est valide. Il est recommandé de l’utiliser uniquement dans un environnement hors production.Consultez Ouverture et fermeture de l’URL de liaison sociale pour plus d’informations.
base64
boolean
défaut:false
Si la clé privée est encodée en base64, définissez sur true.Encodez le fichier private.key en base64 et transmettez la chaîne sur une seule ligne dans le champ privateKey.Ex. sous Linux : cat private.key | base64
expiresIn
number
défaut:5
Définissez la durée de vie du token en minutes. Plage : 1 minute à 2880 minutes.Consultez Expiration du JWT pour plus d’informations.
email
object
défaut:5
Envoyez un e-mail Connect Accounts avec un lien permettant aux utilisateurs d’accéder directement à leur page de liaison sociale.Consultez E-mail Connect Accounts pour plus d’informations.
Lorsque vous incluez vos identifiants API X, l’URL JWT générée initiera la liaison OAuth à l’aide de votre propre application développeur X. Vos utilisateurs finaux verront le nom de votre application sur l’écran de consentement X.
Obligatoire : avant d’utiliser cette fonctionnalité, vous devez ajouter ces URL de rappel aux paramètres de votre application développeur X (sous Authentication settings > Callback URI / Redirect URL) :
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
Sans elles, le flux OAuth échouera avec une erreur 403 Callback URL not approved.