Chuyển đến nội dung chính
POST
Tạo JSON Web Token (JWT) để sử dụng với single sign on. Xem Tổng quan Generate JWT để biết thêm chi tiết.
URL JWT có hiệu lực trong 5 phút. Sau 5 phút bạn phải tạo URL JWT mới. Xem Max Pack expiresIn để biết các tùy chọn bổ sung.

Tham số Header

X-Twitter-OAuth1-Api-Key
string
X API Key (Consumer Key) của bạn từ X Developer Portal. Thay thế cho tham số body twitterApiKey. Khi được cung cấp, URL JWT được tạo sẽ sử dụng X Developer App của bạn cho liên kết OAuth.
X-Twitter-OAuth1-Api-Secret
string
X API Secret (Consumer Secret) của bạn từ X Developer Portal. Thay thế cho tham số body twitterApiSecret. Bắt buộc khi X-Twitter-OAuth1-Api-Key được cung cấp.
Khuyến nghị: Truyền thông tin xác thực X qua header (X-Twitter-OAuth1-Api-KeyX-Twitter-OAuth1-Api-Secret) để nhất quán với tất cả các endpoint API Ayrshare khác. Các tham số body twitterApiKeytwitterApiSecret vẫn được hỗ trợ để tương thích ngược.

Tham số Body

domain
string
bắt buộc
Miền của ứng dụng. Vui lòng sử dụng chính xác miền được cấp trong quá trình onboarding.
privateKey
string
bắt buộc
Private Key được sử dụng để mã hóa.
profileKey
string
bắt buộc
User Profile Key. API Key không thể được sử dụng trong trường này.
logout
boolean
mặc định:false
Tự động đăng xuất phiên hiện tại. Không khuyến nghị sử dụng trong production vì nó ảnh hưởng đến hiệu suất.Xem Tự động đăng xuất phiên Profile để biết thêm thông tin.
redirect
string
Chỉ định một URL để chuyển hướng đến khi nút “Done” hoặc hình ảnh logo được nhấp. URL sẽ tự động được rút gọn trong URL JWT được trả về. Chuyển hướng cửa sổ opener gốc bằng cách thêm tham số truy vấn origin=true vào URL chuyển hướng.
allowedSocial
array
Chỉ định các mạng xã hội hiển thị trong trang liên kết. Điều này sẽ ghi đè các mạng xã hội được cấu hình trong trang Social Networks.
Only display Facebook, X/Twitter, LinkedIn, and TikTok
Ghi đè luồng liên kết Instagram nào được sử dụng khi người dùng nhấp vào nút Instagram trên trang liên kết mạng xã hội cho URL này. Các giá trị hợp lệ:
  • instagram: Instagram Login trực tiếp, không yêu cầu Facebook Page.
  • facebook: Liên kết Instagram thông qua Facebook Page đã kết nối.
Force direct Instagram Login for this linking session
Khi bị bỏ qua, trang liên kết sử dụng cài đặt Instagram Login toàn tài khoản của bạn.Xem Phương thức liên kết Instagram để biết thêm thông tin.
verify
boolean
mặc định:false
Xác minh rằng token được tạo là hợp lệ. Khuyến nghị chỉ sử dụng trong môi trường không phải production.Xem Mở và đóng URL liên kết mạng xã hội để biết thêm thông tin.
base64
boolean
mặc định:false
Nếu private key được mã hóa base64, đặt thành true.Mã hóa tệp private.key ở dạng base64 và truyền chuỗi một dòng vào trường privateKey.Ví dụ trên Linux: cat private.key | base64
expiresIn
number
mặc định:5
Đặt thời hạn của token tính bằng phút. Phạm vi: 1 phút đến 2880 phút.Xem JWT Expires In để biết thêm thông tin.
email
object
mặc định:5
Gửi email Connect Accounts với một liên kết để người dùng truy cập trực tiếp vào trang liên kết mạng xã hội của họ.Xem Connect Accounts Email để biết thêm thông tin.
Khi bạn bao gồm thông tin xác thực X API của mình, URL JWT được tạo sẽ khởi tạo liên kết OAuth bằng X Developer App của riêng bạn. Người dùng cuối của bạn sẽ thấy tên ứng dụng của bạn trên màn hình đồng ý X.
Bắt buộc: Trước khi sử dụng tính năng này, bạn phải thêm các URL callback này vào cài đặt X Developer App của mình (trong Authentication settings > Callback URI / Redirect URL):
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
Nếu không có các URL này, luồng OAuth sẽ thất bại với lỗi 403 Callback URL not approved.