Skip to main content
POST
Créez une URL de liaison sociale pour un User Profile (profil d’utilisateur). Envoyez l’url retournée à votre utilisateur, qui l’ouvre pour connecter ses comptes sociaux. C’est la méthode recommandée pour créer une URL de liaison. Elle ne nécessite que votre clé API et une Profile-Key — il n’y a aucune clé privée à envoyer et rien à signer. Contrairement à une URL de liaison créée auparavant, une link session est stockée : vous pouvez donc vérifier si elle a été utilisée et la révoquer avant son expiration. L’url retournée connecte votre utilisateur à son profil : traitez-la comme un mot de passe et n’envoyez chaque URL qu’à un seul utilisateur. Consultez Envoyer l’URL de liaison.
L’URL est valide pendant 5 minutes par défaut. Utilisez expiresIn pour définir une fenêtre différente, jusqu’à 2880 minutes (48 heures).
Générer une URL de liaison réalise la même opération et continue de fonctionner sans changement. Il accepte les paramètres historiques privateKey, base64 et verify et les ignore. domain n’est ignoré sur aucun des deux endpoints : il reste optionnel et est toujours validé. Les nouvelles intégrations devraient utiliser cet endpoint.Une différence dans la réponse : generateJWT renvoie un token de premier niveau pour la rétrocompatibilité, et cet endpoint n’en renvoie pas un à côté d’une url — le token d’une url vit à l’intérieur de celle-ci. Si vous migrez et que votre code lit token, lisez url à la place. (Le mode connect pour le widget intégré est la seule forme qui retourne un token nu, car elle ne retourne aucune URL dans laquelle le token pourrait vivre.)

Paramètres d’en-tête

La Profile-Key est un en-tête sur cet endpoint — il n’y a pas de paramètre de corps profileKey. Si elle est absente, vous obtenez code: 188, dont le message liste privateKey, profileKey et d’autres noms de champs historiques, car il est partagé avec Générer une URL de liaison. Lisez-le comme « l’en-tête Profile-Key est absent ou incorrect » ; aucun des autres noms qu’il mentionne n’est un paramètre de cet endpoint.
string
Votre clé API X (Consumer Key) provenant du X Developer Portal. Lorsqu’elle est fournie, l’URL de liaison utilisera votre propre application développeur X pour la liaison OAuth.
string
Votre secret API X (Consumer Secret) provenant du X Developer Portal. Requis lorsque X-Twitter-OAuth1-Api-Key est fourni.

Paramètres du corps

string
défaut:"grid"
La surface de liaison que cette session pilote.
  • grid — la page de liaison hébergée, affichant chaque réseau que vous permettez. C’est la valeur par défaut, donc une requête qui omet mode en crée une.
  • connect — un réseau à la fois, ouvert depuis votre propre tableau de bord. Consultez Mode connect ci-dessous et le mode direct.
Jamais inféré : passer origin ou network ne vous met pas en mode connect, donc une session grid ne peut pas devenir une session soumise à conditions par accident. Toute autre valeur retourne code: 188 avec des details nommant les deux valeurs.
number
défaut:5
Durée de vie du lien en minutes. Plage : 1 à 2880 minutes.Nécessite le Max Pack.Consultez Expiration du lien pour plus d’informations.
boolean
défaut:false
Déconnecte automatiquement la session en cours. Non recommandé en production, car cela affecte les performances.Consultez Déconnexion automatique d’une session de profil.
string
Une URL vers laquelle rediriger lorsque le bouton « Done » ou l’image du logo est cliqué. Ajoutez le paramètre de requête origin=true pour rediriger la fenêtre d’ouverture.
array
Les réseaux sociaux à afficher sur la page de liaison. Remplace les réseaux configurés dans la page Réseaux sociaux.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
string
Mode connect uniquement. Le seul réseau social que cette session connecte, ce qui en fait une session en mode direct. Omettez-le pour une session que votre propre tableau de bord pilote sur plusieurs réseaux.L’une des valeurs bluesky, facebook, gmb, instagram, instagramApi, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, whatsapp, x, youtube. Toute autre valeur retourne code: 508 — y compris fbg, qui n’est pas une cible de liaison ici.Ne peut pas être combiné avec allowedSocial (code: 507) : une session mono-réseau est déjà sa propre allowlist. Un réseau que votre compte n’a pas activé retourne code: 509, qui est une réponse différente de 508 parce qu’elle est corrigeable sur votre page Réseaux sociaux.En mode grid, il est ignoré.
Remplace le flux de liaison Instagram utilisé pour ce lien. Valeurs valides :
  • instagram : Instagram Login direct, aucune page Facebook requise.
  • facebook : lier Instagram via une page Facebook connectée.
Lorsqu’omis, la page de liaison utilise votre paramètre Instagram Login à l’échelle du compte.
string
L’origine exacte de la page qui a ouvert la fenêtre de liaison, afin qu’elle puisse être informée lorsque la liaison se termine.Lorsqu’elle est définie, la page de liaison poste des événements à cette origine avec window.postMessage à mesure que votre utilisateur connecte chaque compte, et votre page peut réagir sans polling. Les événements ne sont jamais envoyés qu’à cette valeur exacte, donc elle doit correspondre à l’origine de votre page caractère par caractère, y compris le schéma et tout port éventuel.Trois formes sont acceptées : une origine https (https://app.example.com), http://localhost:3000 pour le développement local, et un schéma personnalisé natif (myapp://connected). Toute autre valeur — une origine http:// simple autre que localhost, ou quelque chose qui n’est pas du tout une origine — est ignorée sur les liens que cet endpoint crée : le lien fonctionne toujours, il n’envoie simplement aucun événement. Le paramètre est optionnel, donc l’omettre n’est pas une erreur non plus.Des trois, seules les deux premières reçoivent des événements. Un schéma personnalisé est une cible de retour pour une application mobile et ne peut pas en recevoir, car il n’y a pas de fenêtre de navigateur à laquelle poster ; les applications natives pollent Obtenir une session de liaison à la place.Consultez Événements de fin de liaison.En mode connect, origin est requis, et il est vérifié. La tolérance ci-dessus est le comportement du mode grid. Avec mode: "connect", l’omettre retourne code: 505 et une valeur qui n’est pas l’une des trois formes acceptées retourne code: 506, dont les details répètent la forme que vous avez envoyée.
string
Optionnel. Votre domaine de liaison, lorsque votre compte en possède plusieurs. S’il est omis, le domaine propre à votre compte est utilisé. Un domaine non enregistré sur votre compte est rejeté.
object
Envoie un e-mail Connect Accounts contenant le lien, afin que votre utilisateur accède directement à sa page de liaison. Nécessite une adresse to.Nécessite le Max Pack. La réponse indique le résultat dans emailSent, et un échec d’envoi retourne code: 333 au lieu d’une réponse de succès.Consultez E-mail Connect Accounts.

Mode connect

mode: "connect" crée une session pour une surface de liaison que vous hébergez vous-même, plutôt que pour la page de liaison hébergée. Laquelle des deux formes connect vous obtenez dépend d’une seule chose — si vous passez network :
La réponse porte le secret exactement une fois. Une réponse a soit une url, soit un token, jamais les deux et jamais deux URL. Le token d’une session en mode direct vit à l’intérieur de l’url, exactement comme en mode grid ; une session sans URL pour le porter retourne le token nu à la place. Tout le reste est identique dans les trois modes : sessionId, expiresAt, emailSent, et title lorsque le User Profile en a un.

Ce que le mode connect nécessite

Aucun des deux n’est un champ de corps à part entière — le premier est un droit du compte et le second est le paramètre origin ci-dessus, que le mode connect rend obligatoire. Le Max Pack. Sans lui, l’appel retourne code: 504, vérifié avant les paramètres du mode connect, donc corriger origin ou network ne changera pas la réponse. Contactez le support si vous avez besoin du mode connect sur un compte sans le Max Pack. Un origin, sur chaque session. Il n’y a pas d’allowlist ni d’étape d’enregistrement — vous l’envoyez à chaque appel et il est stocké sur la session, donc un nouvel environnement ne nécessite aucune configuration de notre côté. Trois formes sont acceptées :
  • une origine httpshttps://app.example.com
  • un schéma personnalisé natif — myapp://connected
  • http://localhost ou http://localhost:3000, pour le développement local
Origine uniquement : pas de chemin, de requête ou de fragment, et pas d’identifiants dedans. L’omettre retourne code: 505, et tout ce qui n’est pas l’une des trois formes retourne code: 506.
email ne peut pas être utilisé avec une session qui n’a pas de network, car il n’y a aucun lien à mettre dans l’e-mail — cette forme retourne un token pour votre propre front-end. L’appel retourne code: 510. Ajoutez un network pour une session en mode direct, qui a bien une URL, ou omettez email.
Chaque code nommé ci-dessus figure dans la référence Erreurs de session de liaison.