Skip to main content
POST
Crea una URL de vinculación social para un User Profile. Envía la url devuelta a tu usuario, y este la abre para conectar sus cuentas sociales. Esta es la forma recomendada de crear una URL de vinculación. Solo necesita tu API Key y una Profile-Key: no hay ninguna clave privada que enviar ni nada que firmar. A diferencia de una URL de vinculación creada antes, una link session queda almacenada, así que puedes comprobar si se ha usado y revocarla antes de que caduque. La url devuelta inicia la sesión de tu usuario en su perfil, así que trátala como una contraseña y envía cada una a un solo usuario. Consulta Enviar la URL de vinculación.
La URL es válida durante 5 minutos por defecto. Usa expiresIn para establecer una ventana distinta, de hasta 2880 minutos (48 horas).
Generar una URL de vinculación realiza la misma operación y sigue funcionando sin cambios. Acepta los parámetros heredados privateKey, base64 y verify y los ignora. domain no se ignora en ninguno de los dos endpoints: sigue siendo opcional y se sigue validando. Las nuevas integraciones deberían usar este endpoint.Una diferencia en la respuesta: generateJWT devuelve un token de nivel superior por retrocompatibilidad, y este endpoint no devuelve uno junto a una url — el token de una url vive dentro de ella. Si estás migrando y tu código lee token, lee url en su lugar. (El modo connect para el widget incrustado es la única forma que devuelve un token suelto, porque no devuelve ninguna URL en la que el token pueda vivir.)

Parámetros de cabecera

La Profile-Key es una cabecera en este endpoint: no hay ningún parámetro profileKey en el cuerpo. Si falta, obtienes code: 188, cuyo mensaje enumera privateKey, profileKey y otros nombres de campos heredados porque se comparte con Generar una URL de vinculación. Interprétalo como «falta la cabecera Profile-Key o es incorrecta»; ninguno de los otros nombres que aparecen es un parámetro de este endpoint.
string
Tu X API Key (Consumer Key) del X Developer Portal. Cuando se proporciona, la URL de vinculación usará tu propia X Developer App para la vinculación mediante OAuth.
string
Tu X API Secret (Consumer Secret) del X Developer Portal. Obligatorio cuando se proporciona X-Twitter-OAuth1-Api-Key.

Parámetros del cuerpo

string
predeterminado:"grid"
Qué superficie de vinculación controla esta sesión.
  • grid — la página de vinculación alojada, que muestra todas las redes que permites. Es el valor por defecto, así que una solicitud que omite mode crea una de estas.
  • connect — una red cada vez, abierta desde tu propio dashboard. Consulta Modo connect más abajo y el modo directo.
Nunca se infiere: pasar origin o network no te pone en modo connect, así que una sesión grid no puede convertirse en una con requisitos por accidente. Cualquier otro valor devuelve code: 188 con details nombrando los dos.
number
predeterminado:5
Duración del enlace en minutos. Rango: de 1 a 2880 minutos.Requiere el Max Pack.Consulta Caducidad del enlace para más información.
boolean
predeterminado:false
Cierra automáticamente la sesión actual. No se recomienda en producción, ya que afecta al rendimiento.Consulta Cierre de sesión automático de una sesión de perfil.
string
Una URL a la que redirigir cuando se haga clic en el botón “Done” (Hecho) o en la imagen del logo. Añade el parámetro de consulta origin=true para redirigir la ventana que abrió el enlace.
array
Las redes sociales que se mostrarán en la página de vinculación. Sobrescribe las redes configuradas en la página Social Networks.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
string
Solo en modo connect. La única red social que conecta esta sesión, que es lo que la convierte en una sesión en modo directo. Omítelo para una sesión que tu propio dashboard controla a través de varias redes.Una de bluesky, facebook, gmb, instagram, instagramApi, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, whatsapp, x, youtube. Cualquier otra cosa devuelve code: 508 — incluido fbg, que aquí no es un destino de vinculación.No puede combinarse con allowedSocial (code: 507): una sesión de una sola red ya es su propia allowlist. Una red que tu cuenta no ha habilitado devuelve code: 509, que es una respuesta distinta de 508 porque se puede arreglar en tu página Social Networks.En modo grid se ignora.
Sobrescribe el flujo de vinculación de Instagram que se usa para este enlace. Valores válidos:
  • instagram: Instagram Login directo, no requiere Facebook Page.
  • facebook: vincula Instagram a través de una Facebook Page conectada.
Cuando se omite, la página de vinculación utiliza tu ajuste global de cuenta Instagram Login.
string
El origen exacto de la página que abrió la ventana de vinculación, para que se le pueda avisar cuando la vinculación termine.Cuando se establece, la página de vinculación envía eventos a ese origen con window.postMessage a medida que tu usuario conecta cada cuenta, y tu página puede reaccionar sin hacer polling. Los eventos solo se envían a este valor exacto, así que debe coincidir con el origen de tu página carácter por carácter, incluidos el esquema y cualquier puerto.Se aceptan tres formas: un origen https (https://app.example.com), http://localhost:3000 para desarrollo local, y un esquema personalizado nativo (myapp://connected). Cualquier otra cosa — un origen http:// plano que no sea localhost, o algo que directamente no es un origen — se ignora en los enlaces que crea este endpoint: el enlace sigue funcionando, simplemente no envía eventos. Es opcional, así que omitirlo tampoco es un error.De las tres, solo las dos primeras reciben eventos. Un esquema personalizado es un destino de retorno para una app móvil y no puede recibirlos, porque no hay ventana de navegador a la que enviarlos; las apps nativas hacen polling de Obtener una Link Session en su lugar.Consulta Eventos de finalización de vinculación.En modo connect origin es obligatorio, y se comprueba. La tolerancia de arriba es comportamiento del modo grid. Con mode: "connect", omitirlo devuelve code: 505 y un valor que no sea una de las tres formas aceptadas devuelve code: 506, cuyos details repiten la forma que enviaste.
string
Opcional. Tu dominio de vinculación, cuando tu cuenta tiene más de uno. Si se omite, se usa el dominio propio de tu cuenta. Un dominio no registrado en tu cuenta se rechaza.
object
Envía un correo de Connect Accounts con el enlace, para que tu usuario pueda llegar directamente a su página de vinculación. Requiere una dirección to.Requiere el Max Pack. La respuesta informa del resultado en emailSent. Si el correo no se puede enviar, igualmente recibes el enlace: la respuesta incluye emailSent: false y un objeto emailError, para que puedas enviar el enlace a tu usuario de otra forma.Consulta Connect Accounts Email.

Modo connect

mode: "connect" crea una sesión para una superficie de vinculación que alojas tú mismo, en lugar de para la página de vinculación alojada. Cuál de las dos formas connect obtienes depende de una cosa — si pasas network:
La respuesta lleva el secreto exactamente una vez. Una respuesta tiene o una url o un token, nunca ambos y nunca dos URL. El token de una sesión en modo directo vive dentro de la url, igual que en modo grid; una sesión sin URL que lo lleve devuelve el token suelto en su lugar. Todo lo demás es igual en los tres modos: sessionId, expiresAt, emailSent y title cuando el User Profile tiene uno.

Qué requiere el modo connect

Ninguno de estos dos es un campo del cuerpo por sí mismo — el primero es una prestación de la cuenta y el segundo es el parámetro origin de arriba, que el modo connect hace obligatorio. El Max Pack. Sin él, la llamada devuelve code: 504, comprobado antes que los parámetros de modo connect, así que corregir origin o network no cambiará la respuesta. Contacta con soporte si necesitas habilitar el modo connect en una cuenta sin el Max Pack. Un origin, en cada sesión. No hay allowlist ni paso de registro — lo envías en cada llamada y se almacena en la sesión, así que un entorno nuevo no necesita ninguna configuración en nuestro lado. Se aceptan tres formas:
  • un origen https — https://app.example.com
  • un esquema personalizado nativo — myapp://connected
  • http://localhost o http://localhost:3000, para desarrollo local
Solo el origen: sin ruta, consulta ni fragmento, y sin credenciales dentro. Omitirlo devuelve code: 505, y cualquier cosa que no sea una de las tres formas devuelve code: 506.
email no puede usarse con una sesión que no tiene network, porque no hay ningún enlace que poner en el correo — esa forma devuelve un token para tu propio front end. La llamada devuelve code: 510. Añade una network para una sesión en modo directo, que sí tiene URL, u omite email.
Todos los códigos nombrados arriba están en la referencia de Errores de link session.