產生 JWT

產生用於單一登入（SSO）的 JSON Web Token（JWT）。

POST /profiles/generateJWT

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-H "X-Twitter-OAuth1-Api-Key: YOUR_CONSUMER_KEY" \
-H "X-Twitter-OAuth1-Api-Secret: YOUR_CONSUMER_SECRET" \
-d '{"domain": "ACME", "privateKey": "-----BEGIN RSA PRIVATE KEY...", "profileKey": "PROFILE_KEY"}' \
-X POST https://api.ayrshare.com/api/profiles/generateJWT

const fs = require('fs');
const API_KEY = "API_KEY";
const PROFILE_KEY = "PROFILE_KEY";

// Read in local private.key files - also can read from a DB
const privateKey = fs.readFileSync('private.key', 'utf8');

fetch("https://api.ayrshare.com/api/profiles/generateJWT", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`,
        "X-Twitter-OAuth1-Api-Key": "YOUR_CONSUMER_KEY",
        "X-Twitter-OAuth1-Api-Secret": "YOUR_CONSUMER_SECRET"
      },
      body: JSON.stringify({
        domain: "ACME",          // required
        privateKey,              // required
        profileKey: PROFILE_KEY, // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

# Read in local private.key files - also can read from a DB
with open('.private.key') as f:
    profileKey = f.read()

payload = {'domain': 'ACME',
        'privateKey': profileKey,
        'profileKey': 'PROFILE_KEY' }
headers = {'Content-Type': 'application/json',
        'Authorization': 'Bearer API_KEY',
        'X-Twitter-OAuth1-Api-Key': 'YOUR_CONSUMER_KEY',
        'X-Twitter-OAuth1-Api-Secret': 'YOUR_CONSUMER_SECRET'}

r = requests.post('https://api.ayrshare.com/api/profiles/generateJWT',
    json=payload,
    headers=headers)

print(r.json())

<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See .../guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://api.ayrshare.com/api/post',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'domain' => 'ACME',
            'privateKey' => '-----BEGIN RSA PRIVATE KEY...', // required
            'profileKey' => 'PROFILE_KEY', // requires
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.IO;
using Newtonsoft.Json;

namespace GenerateJWTRequest_csharp
{
  class GenerateJWT
  {
      static async Task Main(string[] args)
      {
          string API_KEY = "API_KEY";
          string url = "https://api.ayrshare.com/api/profiles/generateJWT";

          try
          {
              string privateKey = await File.ReadAllTextAsync("./private.key");

              var sendData = new
              {
                  domain = "domain",
                  privateKey = privateKey,
                  profileKey = "PROFILE_KEY"
              };

              using (var client = new HttpClient())
              {
                  client.DefaultRequestHeaders.Add("Authorization", "Bearer " + API_KEY);

                  string jsonData = JsonConvert.SerializeObject(sendData);
                  var content = new StringContent(jsonData, Encoding.UTF8, "application/json");

                  HttpResponseMessage response = await client.PostAsync(url, content);
                  response.EnsureSuccessStatusCode();

                  string responseBody = await response.Content.ReadAsStringAsync();
                  Console.WriteLine(responseBody);
              }
          }
          catch (FileNotFoundException e)
          {
              Console.WriteLine($"Private key file not found: {e.Message}");
          }
          catch (HttpRequestException e)
          {
              Console.WriteLine($"HTTP request error: {e.Message}");
          }
          catch (Exception e)
          {
              Console.WriteLine($"Unexpected error: {e.Message}");
          }
      }
  }
}

200: Success

{
    "status": "success",
    "title": "User Profile Title",
    "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcGlLZXkiOiJBSjNQR1cxLThIWk04UjQtR0NXVFZKVy1ZRTE1M1BFIiwicHJvZmlsZUtleSI6IjhKNDY4UFktSjM5TVlXRC1IWEpLVlIyLVBRMjBQUlMiLCJpYXQiOjE2MTQyMjYwNDksImV4cCI6MTYxNDIyNjM0OSwiYXVkIjoiaHR0cHM6Ly9hcHAuYXlyc2hhcmUuY29tIiwiaXNzIjoiYm9uZGJyYW5kbG95YWx0eS5jb20iLCJzdWIiOiJzdXBwb3J0QGF5cnNoYXJlLmNvbSJ9.Se387OyhJIdaDkFkvAe0Dwo3pQrHBwdg2bbjqKYn7BZuVDxPboJmTsd7rra8N-Z6b9_fJOtwlRFGBLW1CvgLGU4RSisTVqjqhAkb3KNhpA7cZ673IJbRX-ST7tYadKKzmd9GNrZW9rhxHOlgMJ9uOboc4dcaDbNmzb_yCrfLY-E"
    "url": "https://profile.ayrshare.com?domain=PROVIDED_DOMAIN&jwt=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcGlLZXkiOiJBSjNQR1cxLThIWk04UjQtR0NXVFZKVy1ZRTE1M1BFIiwicHJvZmlsZUtleSI6IjhKNDY4UFktSjM5TVlXRC1IWEpLVlIyLVBRMjBQUlMiLCJpYXQiOjE2MTQyMjYwNDksImV4cCI6MTYxNDIyNjM0OSwiYXVkIjoiaHR0cHM6Ly9hcHAuYXlyc2hhcmUuY29tIiwiaXNzIjoiYm9uZGJyYW5kbG95YWx0eS5jb20iLCJzdWIiOiJzdXBwb3J0QGF5cnNoYXJlLmNvbSJ9.Se387OyhJIdaDkFkvAe0Dwo3pQrHBwdg2bbjqKYn7BZuVDxPboJmTsd7rra8N-Z6b9_fJOtwlRFGBLW1CvgLGU4RSisTVqjqhAkb3KNhpA7cZ673IJbRX-ST7tYadKKzmd9GNrZW9rhxHOlgMJ9uOboc4dcaDbNmzb_yCrfLY-E",
    "emailSent": true,    
    "expiresIn": "30m"    
}

{
  "action": "JWT",
  "status": "error",
  "code": 189,
  "message": "Error generating JWT. Check the sent parameters, such as the privateKey has no extra tabs, spaces, or newlines. Error: error:0909006C:PEM routines:get_name:no start line"
}

{
  "action": "JWT",
  "status": "error",
  "code": 188,
  "message": "Both twitterApiKey and twitterApiSecret are required. You provided only one."
}

{
    "action": "JWT",
    "status": "error",
    "code": 434,
    "message": "X/Twitter API credentials were provided in both the request headers and the request body. Please use the headers only. See https://www.ayrshare.com/docs/apis/profiles/generate-jwt"
}

產生用於單一登入（SSO）的 JSON Web Token（JWT）。

詳情請參閱 Generate JWT 概觀。

JWT URL 的有效期為 5 分鐘。5 分鐘後你必須產生新的 JWT URL。 其他選項請參閱 Max Pack 的 expiresIn 設定。

​

標頭參數

X-Twitter-OAuth1-Api-Key · string

你從 X Developer Portal 取得的 X API Key（Consumer Key）。是 twitterApiKey body 參數的替代方式。當提供時，產生的 JWT URL 將使用你自己的 X Developer App 進行 OAuth 連結。

X-Twitter-OAuth1-Api-Secret · string

你從 X Developer Portal 取得的 X API Secret（Consumer Secret）。是 twitterApiSecret body 參數的替代方式。當提供了 X-Twitter-OAuth1-Api-Key 時為必填。

**建議：**透過標頭（X-Twitter-OAuth1-Api-Key 與 X-Twitter-OAuth1-Api-Secret）傳遞你的 X 認證資料，以便與所有其他 Ayrshare API 端點的做法保持一致。為了向下相容，仍然支援 twitterApiKey 與 twitterApiSecret body 參數。

​

Body 參數

domain · string · 必填

App 的網域。請使用你在導入期間所取得的確切網域。

privateKey · string · 必填

用於加密的 Private Key。

profileKey · string · 必填

User Profile Key。此欄位不能使用 API Key。

logout · boolean · 預設值: false

自動登出目前的工作階段。建議不要在正式環境中使用，因為會影響效能。

更多資訊請參閱自動登出 Profile 工作階段。

redirect · string

指定當使用者點擊「Done」按鈕或 Logo 圖片時要轉向的 URL。該 URL 會在回傳的 JWT URL 中自動被縮短。若要轉向原始開啟者視窗，請在 redirect URL 中加入 origin=true 查詢參數。

allowedSocial · array

指定要在連結頁面上顯示的社群網路。此設定會覆寫 Social Networks 頁面所設定的社群網路。

Only display Facebook, X/Twitter, LinkedIn, and TikTok

{
  "allowedSocial": ["facebook", "twitter", "linkedin", "tiktok"]
}

instagramLinkMethod · string

針對此 URL，覆寫使用者在社群連結頁面點擊 Instagram 按鈕時所使用的 Instagram 連結流程。有效值：

• instagram：直接的 Instagram Login，不需 Facebook 粉絲專頁。
• facebook：透過已連結的 Facebook 粉絲專頁連結 Instagram。

Force direct Instagram Login for this linking session

{
  "instagramLinkMethod": "instagram"
}

若省略此欄位，連結頁面將沿用你的帳號層級 Instagram Login 設定。

更多資訊請參閱 Instagram 連結方式。

verify · boolean · 預設值: false

驗證產生的 Token 是否有效。建議僅在非正式環境使用。

更多資訊請參閱開啟與關閉社群連結 URL。

base64 · boolean · 預設值: false

若 Private Key 為 base64 編碼，請設為 true。

將 private.key 檔案以 base64 編碼，並將產生的單行字串以 privateKey 欄位傳入。

例如在 Linux 中：cat private.key | base64

expiresIn · number · 預設值: 5

設定 Token 的有效期，單位為分鐘。範圍：1 分鐘至 2880 分鐘。

更多資訊請參閱 JWT Expires In。

email · object · 預設值: 5

寄送 Connect Accounts 電子郵件，內含可讓使用者直接前往社群連結頁面的連結。

更多資訊請參閱 Connect Accounts 電子郵件。

當你附上 X API 認證資料時，產生的 JWT URL 將以你自己的 X Developer App 啟動 OAuth 連結流程。你的終端使用者會在 X 的授權同意畫面上看到你的 App 名稱。

**必要條件：**在使用此功能之前，你必須在 X Developer App 設定中（Authentication settings > Callback URI / Redirect URL）加入以下回呼 URL：

• https://profile.ayrshare.com/social-accounts
• https://app.ayrshare.com/social-accounts

若未設定，OAuth 流程將失敗並回傳 403 Callback URL not approved 錯誤。

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-H "X-Twitter-OAuth1-Api-Key: YOUR_CONSUMER_KEY" \
-H "X-Twitter-OAuth1-Api-Secret: YOUR_CONSUMER_SECRET" \
-d '{"domain": "ACME", "privateKey": "-----BEGIN RSA PRIVATE KEY...", "profileKey": "PROFILE_KEY"}' \
-X POST https://api.ayrshare.com/api/profiles/generateJWT

const fs = require('fs');
const API_KEY = "API_KEY";
const PROFILE_KEY = "PROFILE_KEY";

// Read in local private.key files - also can read from a DB
const privateKey = fs.readFileSync('private.key', 'utf8');

fetch("https://api.ayrshare.com/api/profiles/generateJWT", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`,
        "X-Twitter-OAuth1-Api-Key": "YOUR_CONSUMER_KEY",
        "X-Twitter-OAuth1-Api-Secret": "YOUR_CONSUMER_SECRET"
      },
      body: JSON.stringify({
        domain: "ACME",          // required
        privateKey,              // required
        profileKey: PROFILE_KEY, // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

# Read in local private.key files - also can read from a DB
with open('.private.key') as f:
    profileKey = f.read()

payload = {'domain': 'ACME',
        'privateKey': profileKey,
        'profileKey': 'PROFILE_KEY' }
headers = {'Content-Type': 'application/json',
        'Authorization': 'Bearer API_KEY',
        'X-Twitter-OAuth1-Api-Key': 'YOUR_CONSUMER_KEY',
        'X-Twitter-OAuth1-Api-Secret': 'YOUR_CONSUMER_SECRET'}

r = requests.post('https://api.ayrshare.com/api/profiles/generateJWT',
    json=payload,
    headers=headers)

print(r.json())

<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See .../guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://api.ayrshare.com/api/post',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'domain' => 'ACME',
            'privateKey' => '-----BEGIN RSA PRIVATE KEY...', // required
            'profileKey' => 'PROFILE_KEY', // requires
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.IO;
using Newtonsoft.Json;

namespace GenerateJWTRequest_csharp
{
  class GenerateJWT
  {
      static async Task Main(string[] args)
      {
          string API_KEY = "API_KEY";
          string url = "https://api.ayrshare.com/api/profiles/generateJWT";

          try
          {
              string privateKey = await File.ReadAllTextAsync("./private.key");

              var sendData = new
              {
                  domain = "domain",
                  privateKey = privateKey,
                  profileKey = "PROFILE_KEY"
              };

              using (var client = new HttpClient())
              {
                  client.DefaultRequestHeaders.Add("Authorization", "Bearer " + API_KEY);

                  string jsonData = JsonConvert.SerializeObject(sendData);
                  var content = new StringContent(jsonData, Encoding.UTF8, "application/json");

                  HttpResponseMessage response = await client.PostAsync(url, content);
                  response.EnsureSuccessStatusCode();

                  string responseBody = await response.Content.ReadAsStringAsync();
                  Console.WriteLine(responseBody);
              }
          }
          catch (FileNotFoundException e)
          {
              Console.WriteLine($"Private key file not found: {e.Message}");
          }
          catch (HttpRequestException e)
          {
              Console.WriteLine($"HTTP request error: {e.Message}");
          }
          catch (Exception e)
          {
              Console.WriteLine($"Unexpected error: {e.Message}");
          }
      }
  }
}

200: Success

{
    "status": "success",
    "title": "User Profile Title",
    "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcGlLZXkiOiJBSjNQR1cxLThIWk04UjQtR0NXVFZKVy1ZRTE1M1BFIiwicHJvZmlsZUtleSI6IjhKNDY4UFktSjM5TVlXRC1IWEpLVlIyLVBRMjBQUlMiLCJpYXQiOjE2MTQyMjYwNDksImV4cCI6MTYxNDIyNjM0OSwiYXVkIjoiaHR0cHM6Ly9hcHAuYXlyc2hhcmUuY29tIiwiaXNzIjoiYm9uZGJyYW5kbG95YWx0eS5jb20iLCJzdWIiOiJzdXBwb3J0QGF5cnNoYXJlLmNvbSJ9.Se387OyhJIdaDkFkvAe0Dwo3pQrHBwdg2bbjqKYn7BZuVDxPboJmTsd7rra8N-Z6b9_fJOtwlRFGBLW1CvgLGU4RSisTVqjqhAkb3KNhpA7cZ673IJbRX-ST7tYadKKzmd9GNrZW9rhxHOlgMJ9uOboc4dcaDbNmzb_yCrfLY-E"
    "url": "https://profile.ayrshare.com?domain=PROVIDED_DOMAIN&jwt=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcGlLZXkiOiJBSjNQR1cxLThIWk04UjQtR0NXVFZKVy1ZRTE1M1BFIiwicHJvZmlsZUtleSI6IjhKNDY4UFktSjM5TVlXRC1IWEpLVlIyLVBRMjBQUlMiLCJpYXQiOjE2MTQyMjYwNDksImV4cCI6MTYxNDIyNjM0OSwiYXVkIjoiaHR0cHM6Ly9hcHAuYXlyc2hhcmUuY29tIiwiaXNzIjoiYm9uZGJyYW5kbG95YWx0eS5jb20iLCJzdWIiOiJzdXBwb3J0QGF5cnNoYXJlLmNvbSJ9.Se387OyhJIdaDkFkvAe0Dwo3pQrHBwdg2bbjqKYn7BZuVDxPboJmTsd7rra8N-Z6b9_fJOtwlRFGBLW1CvgLGU4RSisTVqjqhAkb3KNhpA7cZ673IJbRX-ST7tYadKKzmd9GNrZW9rhxHOlgMJ9uOboc4dcaDbNmzb_yCrfLY-E",
    "emailSent": true,    
    "expiresIn": "30m"    
}

{
  "action": "JWT",
  "status": "error",
  "code": 189,
  "message": "Error generating JWT. Check the sent parameters, such as the privateKey has no extra tabs, spaces, or newlines. Error: error:0909006C:PEM routines:get_name:no start line"
}

{
  "action": "JWT",
  "status": "error",
  "code": 188,
  "message": "Both twitterApiKey and twitterApiSecret are required. You provided only one."
}

{
    "action": "JWT",
    "status": "error",
    "code": 434,
    "message": "X/Twitter API credentials were provided in both the request headers and the request body. Please use the headers only. See https://www.ayrshare.com/docs/apis/profiles/generate-jwt"
}