Saltar al contenido principal
POST
Genera un JSON Web Token (JWT) para usarlo con single sign on. Consulta la Visión general de Generate JWT para más detalles.
La URL del JWT es válida durante 5 minutos. Pasados 5 minutos deberás generar una nueva URL de JWT. Consulta el expiresIn de Max Pack para opciones adicionales.

Parámetros de cabecera

X-Twitter-OAuth1-Api-Key
string
Tu X API Key (Consumer Key) del X Developer Portal. Alternativa al parámetro twitterApiKey del cuerpo. Cuando se proporciona, la URL del JWT generada usará tu X Developer App para la vinculación mediante OAuth.
X-Twitter-OAuth1-Api-Secret
string
Tu X API Secret (Consumer Secret) del X Developer Portal. Alternativa al parámetro twitterApiSecret del cuerpo. Obligatorio cuando se proporciona X-Twitter-OAuth1-Api-Key.
Recomendado: pasa tus credenciales de X mediante cabeceras (X-Twitter-OAuth1-Api-Key y X-Twitter-OAuth1-Api-Secret) para mantener la coherencia con todos los demás endpoints de la API de Ayrshare. Los parámetros de cuerpo twitterApiKey y twitterApiSecret siguen siendo compatibles por retrocompatibilidad.

Parámetros del cuerpo

domain
string
requerido
Dominio de la aplicación. Utiliza el dominio exacto proporcionado durante el onboarding.
privateKey
string
requerido
Private Key utilizada para el cifrado.
profileKey
string
requerido
User Profile Key. La API Key no se puede usar en este campo.
logout
boolean
predeterminado:false
Cierra automáticamente la sesión actual. Recomendamos no usarlo en producción, ya que afecta al rendimiento.Consulta Cierre de sesión automático de una sesión de perfil para más información.
redirect
string
Especifica una URL a la que redirigir cuando se haga clic en el botón “Done” o en la imagen del logo. La URL se acortará automáticamente en la URL del JWT devuelta. Redirige la ventana origin que abrió el enlace añadiendo el parámetro de consulta origin=true a la URL de redirección.
allowedSocial
array
Especifica las redes sociales que se mostrarán en la página de vinculación. Esto sobrescribirá las redes sociales configuradas en la página Social Networks.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
Sobrescribe el flujo de vinculación de Instagram que se usa cuando un usuario hace clic en el botón de Instagram en la página de vinculación social para esta URL. Valores válidos:
  • instagram: Instagram Login directo, no requiere Facebook Page.
  • facebook: vincula Instagram a través de una Facebook Page conectada.
Force direct Instagram Login for this linking session
Cuando se omite, la página de vinculación utiliza tu ajuste global de cuenta Instagram Login.Consulta Método de vinculación de Instagram para más información.
verify
boolean
predeterminado:false
Verifica que el token generado sea válido. Recomendamos usarlo solo en entornos que no sean de producción.Consulta Apertura y cierre de la URL de vinculación social para más información.
base64
boolean
predeterminado:false
Si la private key está codificada en base64, establece en true.Codifica el archivo private.key en base64 y pasa el String de una sola línea en el campo privateKey.Por ejemplo, en Linux: cat private.key | base64
expiresIn
number
predeterminado:5
Establece la duración del token en minutos. Rango: de 1 minuto a 2880 minutos.Consulta JWT Expires In para más información.
email
object
predeterminado:5
Envía un correo Connect Accounts con un enlace para que los usuarios accedan directamente a su página de vinculación social.Consulta Connect Accounts Email para más información.
Cuando incluyes tus credenciales de la X API, la URL del JWT generada iniciará la vinculación mediante OAuth usando tu propia X Developer App. Tus usuarios finales verán el nombre de tu app en la pantalla de consentimiento de X.
Obligatorio: antes de usar esta funcionalidad, debes añadir estas URL de callback a los ajustes de tu X Developer App (en Authentication settings > Callback URI / Redirect URL):
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
Sin ellas, el flujo OAuth fallará con un error 403 Callback URL not approved.