Skip to main content
POST
Створіть URL для прив’язки соціальних мереж для User Profile. Надішліть повернутий url вашому користувачу, і він відкриє його, щоб підключити свої соціальні акаунти. Це рекомендований спосіб створення URL для підключення. Потрібні лише ваш API Key і Profile-Key — немає приватного ключа для надсилання й нічого підписувати. На відміну від URL для підключення, створеного раніше, link session зберігається, тож ви можете перевірити, чи його використовували, і відкликати його до завершення строку дії. Повернутий url авторизує вашого користувача в його профілі, тож ставтеся до нього як до пароля й надсилайте кожен лише одному користувачу. Див. Надсилання URL зв’язування.
URL дійсний 5 хвилин за замовчуванням. Використовуйте expiresIn, щоб установити інше вікно, до 2880 хвилин (48 годин).
Генерація URL для підключення виконує ту саму операцію і продовжує працювати без змін. Вона приймає застарілі параметри privateKey, base64 і verify та ігнорує їх. domain не ігнорується на жодному з ендпоінтів — він залишається необов’язковим і досі валідується. Нові інтеграції мають використовувати цей ендпоінт.Одна відмінність у відповіді: generateJWT повертає token на верхньому рівні для зворотної сумісності, а цей ендпоінт не повертає його поруч із url — токен у url живе всередині нього. Якщо ви мігруєте і ваш код читає token, читайте натомість url. (Режим connect для вбудованого віджета — єдина форма, яка повертає голий token, оскільки вона не повертає URL, у якому токен міг би жити.)

Header Parameters

Profile-Key на цьому ендпоінті — заголовок; body-параметра profileKey немає. Якщо він відсутній, ви отримаєте code: 188, повідомлення якого перелічує privateKey, profileKey та інші застарілі назви полів, оскільки воно спільне з Генерацією URL для підключення. Читайте його як «заголовок Profile-Key відсутній або неправильний»; жодна з інших назв у ньому не є параметром цього ендпоінта.
string
Ваш X API Key (Consumer Key) з X Developer Portal. Якщо вказано, URL для підключення використовуватиме ваш власний X Developer App для OAuth-прив’язки.
string
Ваш X API Secret (Consumer Secret) з X Developer Portal. Обов’язково, коли надано X-Twitter-OAuth1-Api-Key.

Body Parameters

string
за замовчуванням:"grid"
Яку поверхню зв’язування обслуговує ця сесія.
  • grid — хостована сторінка зв’язування, що показує кожну мережу, яку ви дозволяєте. Це значення за замовчуванням, тож запит, який пропускає mode, створює саме таку сесію.
  • connect — одна мережа за раз, відкрита з вашої власної панелі керування. Див. Режим connect нижче та прямий режим.
Ніколи не виводиться автоматично: передача origin чи network не переводить вас у режим connect, тож сесія grid не може випадково стати обмеженою. Будь-яке інше значення повертає code: 188 із details, що називає ці два.
number
за замовчуванням:5
Тривалість дії посилання в хвилинах. Діапазон: від 1 до 2880 хвилин.Потребує Max Pack.Див. Строк дії посилання для отримання додаткової інформації.
boolean
за замовчуванням:false
Автоматично завершувати поточну сесію. Не рекомендується використовувати у продакшені, оскільки це впливає на продуктивність.Див. Automatic Logout of a Profile Session.
string
URL для перенаправлення при натисканні кнопки “Done” (Готово) або зображення логотипа. Додайте query-параметр origin=true, щоб перенаправити вікно opener.
array
Соціальні мережі, які відображатимуться на сторінці прив’язки. Перевизначає мережі, налаштовані на сторінці Social Networks.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
string
Лише режим connect. Єдина соціальна мережа, яку підключає ця сесія, — саме це робить її сесією прямого режиму. Пропустіть його для сесії, яку ваша власна панель керування веде через кілька мереж.Одне зі значень bluesky, facebook, gmb, instagram, instagramApi, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, whatsapp, x, youtube. Будь-що інше повертає code: 508 — включно з fbg, який тут не є ціллю зв’язування.Не можна поєднувати з allowedSocial (code: 507): сесія однієї мережі вже сама собі allowlist. Мережа, яку ваш акаунт не ввімкнув, повертає code: 509 — це інша відповідь, ніж 508, бо її можна виправити на вашій сторінці Social Networks.У режимі grid ігнорується.
Перевизначити, який потік прив’язки Instagram використовується для цього посилання. Допустимі значення:
  • instagram: Direct Instagram Login, Facebook Page не потрібна.
  • facebook: прив’язка Instagram через підключену Facebook Page.
Якщо не вказано, сторінка прив’язки використовує ваше загальне для облікового запису налаштування Instagram Login.
string
Точний origin сторінки, яка відкрила вікно зв’язування, щоб їй можна було повідомити, коли зв’язування завершиться.Коли задано, сторінка зв’язування надсилає події на цей origin через window.postMessage, поки ваш користувач підключає кожен акаунт, і ваша сторінка може реагувати без опитування. Події надсилаються лише на це точне значення, тож воно має збігатися з origin вашої сторінки символ у символ, включно зі схемою та будь-яким портом.Приймаються три форми: origin https (https://app.example.com), http://localhost:3000 для локальної розробки та нативна власна схема (myapp://connected). Будь-що інше — звичайний origin http://, окрім localhost, або щось, що взагалі не є origin, — на посиланнях, які створює цей ендпоінт, ігнорується: посилання все одно працює, воно просто не надсилає подій. Параметр необов’язковий, тож його пропуск теж не є помилкою.З цих трьох лише перші дві форми отримують події. Власна схема — це ціль повернення для мобільного застосунку, і вона не може їх отримувати, бо немає вікна браузера, куди надсилати; нативні застосунки натомість опитують Отримання Link Session.Див. Події завершення зв’язування.У режимі connect origin обов’язковий, і він перевіряється. Описана вище поблажливість — поведінка режиму grid. З mode: "connect" його пропуск повертає code: 505, а значення, яке не є однією з трьох прийнятних форм, повертає code: 506, чиї details повторюють форму, яку ви надіслали.
string
Необов’язковий. Ваш домен для підключення, якщо ваш акаунт має більше ніж один. Якщо не вказано, використовується власний домен вашого акаунта. Домен, не зареєстрований на ваш акаунт, відхиляється.
object
Надіслати Connect Accounts email з посиланням, щоб ваш користувач міг безпосередньо перейти до своєї сторінки прив’язки. Потребує адреси to.Потребує Max Pack. Відповідь повідомляє результат у полі emailSent. Якщо email не вдалося надіслати, ви все одно отримуєте посилання: відповідь містить emailSent: false і об’єкт emailError, тож ви можете передати посилання користувачу іншим способом.Див. Connect Accounts Email.

Режим connect

mode: "connect" створює сесію для поверхні зв’язування, яку ви хостите самостійно, а не для хостованої сторінки зв’язування. Яку з двох форм connect ви отримаєте, залежить від одного — чи передаєте ви network:
Відповідь несе секрет рівно один раз. Відповідь має або url, або token — ніколи обидва й ніколи два URL. Токен у сесії прямого режиму живе всередині url, так само як у режимі grid; сесія без URL, який міг би його нести, повертає натомість голий token. Усе інше однакове в усіх трьох режимах: sessionId, expiresAt, emailSent і title, коли User Profile його має.

Що вимагає режим connect

Жодна з цих двох речей не є окремим полем тіла — перша є правом акаунта, а друга — параметром origin вище, який режим connect робить обов’язковим. Max Pack. Без нього виклик повертає code: 504, який перевіряється до параметрів режиму connect, тож виправлення origin чи network не змінить відповіді. Зверніться до підтримки, якщо вам потрібно ввімкнути режим connect на акаунті без Max Pack. origin, на кожній сесії. Немає allowlist і кроку реєстрації — ви надсилаєте його з кожним викликом, і він зберігається на сесії, тож нове середовище не потребує жодних налаштувань на нашому боці. Приймаються три форми:
  • origin https — https://app.example.com
  • нативна власна схема — myapp://connected
  • http://localhost або http://localhost:3000, для локальної розробки
Лише origin: без шляху, query чи фрагмента і без облікових даних у ньому. Його пропуск повертає code: 505, а будь-що, що не є однією з трьох форм, повертає code: 506.
email не можна використовувати із сесією без network, бо немає посилання, яке можна вкласти в лист — ця форма повертає токен для вашого власного фронтенду. Виклик повертає code: 510. Додайте network для сесії прямого режиму, яка таки має URL, або пропустіть email.
Кожен названий вище код є в довіднику Помилки Link Session.