Перейти до основного вмісту
POST
Згенеруйте JSON Web Token (JWT) для використання з єдиним входом (single sign on). Див. Огляд генерації JWT для отримання додаткової інформації.
URL JWT дійсний 5 хвилин. Після 5 хвилин необхідно згенерувати новий JWT URL. Див. Max Pack expiresIn для додаткових опцій.

Header Parameters

X-Twitter-OAuth1-Api-Key
string
Ваш X API Key (Consumer Key) з X Developer Portal. Альтернатива до body-параметра twitterApiKey. Якщо вказано, згенерований JWT URL використовуватиме ваш X Developer App для OAuth-прив’язки.
X-Twitter-OAuth1-Api-Secret
string
Ваш X API Secret (Consumer Secret) з X Developer Portal. Альтернатива до body-параметра twitterApiSecret. Обов’язково, коли надано X-Twitter-OAuth1-Api-Key.
Рекомендовано: передавайте ваші X-облікові дані через заголовки (X-Twitter-OAuth1-Api-Key і X-Twitter-OAuth1-Api-Secret) для узгодженості з усіма іншими endpoint API Ayrshare. Body-параметри twitterApiKey і twitterApiSecret все ще підтримуються для зворотної сумісності.

Body Parameters

domain
string
обов'язково
Домен додатка. Використовуйте точний домен, наданий під час onboarding.
privateKey
string
обов'язково
Приватний ключ, що використовується для шифрування.
profileKey
string
обов'язково
User Profile Key. API Key не можна використовувати в цьому полі.
logout
boolean
за замовчуванням:false
Автоматично завершувати поточну сесію. Не рекомендується використовувати у продакшені, оскільки це впливає на продуктивність.Див. Automatic Logout of a Profile Session для отримання додаткової інформації.
redirect
string
Вкажіть URL для перенаправлення при натисканні кнопки “Done” або зображення логотипа. URL буде автоматично скорочено у поверненому JWT url. Перенаправлення вікна origin opener здійснюється додаванням query-параметра origin=true до URL перенаправлення.
allowedSocial
array
Вкажіть, які соціальні мережі відображати на сторінці прив’язки. Це перевизначить соціальні мережі, налаштовані на сторінці Social Networks.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
Перевизначити, який потік прив’язки Instagram використовується, коли користувач натискає кнопку Instagram на сторінці прив’язки для цього URL. Допустимі значення:
  • instagram: Direct Instagram Login, Facebook Page не потрібна.
  • facebook: прив’язка Instagram через підключену Facebook Page.
Force direct Instagram Login for this linking session
Якщо не вказано, сторінка прив’язки використовує ваше загальне для облікового запису налаштування Instagram Login.Див. Instagram Link Method для отримання додаткової інформації.
verify
boolean
за замовчуванням:false
Перевірити, чи є згенерований токен валідним. Рекомендується використовувати лише в непродакшн-середовищі.Див. Opening and Closing the Social Linking URL для отримання додаткової інформації.
base64
boolean
за замовчуванням:false
Якщо приватний ключ закодовано в base64, встановіть true.Закодуйте файл private.key у base64 і передайте однорядковий String у полі privateKey.Наприклад у Linux: cat private.key | base64
expiresIn
number
за замовчуванням:5
Встановіть тривалість дії токена в хвилинах. Діапазон: від 1 хвилини до 2880 хвилин.Див. JWT Expires In для отримання додаткової інформації.
email
object
за замовчуванням:5
Надіслати Connect Accounts email з посиланням, за яким користувачі можуть безпосередньо перейти до своєї сторінки прив’язки соціальних мереж.Див. Connect Accounts Email для отримання додаткової інформації.
Коли ви включаєте свої X API credentials, згенерований JWT URL ініціюватиме OAuth-прив’язку з використанням вашого власного X Developer App. Ваші кінцеві користувачі побачать назву вашого додатка на екрані згоди X.
Обов’язково: перед використанням цієї функції ви повинні додати ці callback URL до налаштувань вашого X Developer App (у розділі Authentication settings > Callback URI / Redirect URL):
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
Без цього потік OAuth завершиться з помилкою 403 Callback URL not approved.