TikTok webhook එක සත්යාපනය කිරීම: signature header සහ එය පරීක්ෂා කරන ආකාරය
TikTok API for Business සෑම webhook delivery එකක්ම Tiktok-Signature header එකක අත්සන් කරයි, t=<unix seconds>,s=<hex> ආකාරයෙන්. මෙහි s යනු t අගයේ, තිතේ සහ request body එකේ HMAC-SHA256 එකයි, developer යෙදුමේ secret එකෙන් යතුරු ගසා ඇත. එය පරීක්ෂා කිරීමට, ලැබුණු ආකාරයටම raw body එක මත එම HMAC නැවත ගණනය කර, s සමඟ නියත කාලයේ සංසන්දනය කර, පැරණි t ප්රතික්ෂේප කරන්න.
easyCoexistence සෑම comment event එකක් මත එහි යෙදුමට ලැබෙන TikTok signature එක පරීක්ෂා කරයි.
Tiktok-Signature හි කොටස් දෙක: delivery එකේ Unix timestamp එක තත්පර වලින් සහ TikTok එයට ජනනය කළ signature එක.
TikTok හි Node sample හි acceptableDelay, එය ඊට වඩා පැරණි නිවැරදිව අත්සන් කළ delivery එකක් ප්රතික්ෂේප කරයි.
එක් delivery එකකට අනන්ය ID එක ගෙන යන header එක, troubleshooting සඳහා log කිරීමට TikTok ඉල්ලයි.
mention webhooks සඳහා event type එක, ඒවායේ දායකත්ව guide එක එම signature සත්යාපනය වෙත යොමු කරයි.
easyCoexistence හි X-EC-Signature header එකේ signature කොටස, t හි HMAC-SHA256, තිත සහ raw body.
Tiktok-Signature header එක කෙසේ පෙනේද?
කොටස් දෙකක්, කොමාවකින් වෙන් කර: t, එම delivery එකේ Unix timestamp එක තත්පර වලින්, සහ s, signature එක, අක්ෂර 64ක hexadecimal දිගකින්. TikTok හි පිටු නම ලියන්නේ TikTok-Signature, Tiktok-Signature සහ tiktok-signature ලෙසයි. HTTP header නම් අකුරු විශාලත්වය නොසලකයි, එබැවින් එය case-insensitive ලෙස කියවන්න, බොහෝ frameworks දැනටමත් කරන ලෙසම. TikTok sample delivery එකේ අනෙක් headers:
content-type: application/json;charset=UTF-8
user-agent: tiktok-webhook
tiktok-signature: t=1641974633,s=dc023ece112b3a07d809896fd929928a132168d95d2a2e43aab0105fbb291df8
webhook-schema-version: v1.0
x-tt-logid: 202201120803530102451591650189C78TikTok අත්සන් කරන්නේ කුමන bytes ද?
t අගය string එකක් ලෙස, තිතක්, ඉන්පසු body එක. TikTok හි guide එක එම අවසාන කොටස හඳුන්වන්නේ request body හි stringified JSON පිටපතක් ලෙසයි. එහි Node sample එක, දැනටමත් parse කළ object එකක් මත JSON.stringify ධාවනය කරමින් එම පිටපත නැවත ගොඩනගයි. එය TikTok හි bytes පමණක් නැවත ඇති කරන්නේ, serializers දෙකම spacing, key order සහ escaping මත එකඟ වන විට පමණි. එබැවින් JSON middleware එය කියවීමට පෙර, body එය ළඟට ආ ආකාරයටම hash කරන්න.
කුමක් key එක ද?
developer යෙදුමේ secret එක. එය TikTok developer portal හි My Apps, App Detail, Basic Information යටතේ ඇත. එය දැනටමත් යෙදුම /business/webhook/update/ වෙත secret ලෙසත්, token endpoints වෙත client_secret ලෙසත් යවන අගයයි. යෙදුමට අවසර දුන් සෑම ගිණුමක් සඳහාම deliveries අත්සන් කරන්නේ එක් secret එකකි. එබැවින් receiver එකට ගිණුමකට එක් key එකක් අවශ්ය නොවේ, සහ access token එක හෝ යෙදුමේ ID එක කිසිවක් එයට සහභාගී නොවේ.
Node.js හි එය පරීක්ෂා කරන්නේ කෙසේද?
node:crypto සහ raw body සමඟ. පහත function එක header එක බෙදයි, t, තිත සහ body bytes මත HMAC නැවත ගණනය කරයි, ප්රතිඵල නියත කාලයේ සංසන්දනය කරයි, ඉන්පසු t හි වයස පරීක්ෂා කරයි. එයට signature කොටසේ නම තර්කයක් ලෙස ලැබේ, එබැවින් එම කේතයම easyCoexistence හි forwards ද පරීක්ෂා කරයි. එහිදී එම කොටස v1 ලෙස හැඳින්වෙන අතර key එක ගිණුමේ signing secret එකයි:
import express from "express";
import { createHmac, timingSafeEqual } from "node:crypto";
// Tiktok-Signature reads t=<unix>,s=<hex>; X-EC-Signature reads t=<unix>,v1=<hex>.
function verifySignature(rawBody, header, secret, name, maxAgeSeconds = 300) {
const parts = {};
for (const item of String(header ?? "").split(",")) {
const i = item.indexOf("=");
if (i > 0) parts[item.slice(0, i).trim()] = item.slice(i + 1).trim();
}
const signature = parts[name];
if (!/^\d+$/.test(parts.t ?? "") || !signature) return false;
const expected = createHmac("sha256", secret)
.update(parts.t + ".")
.update(rawBody) // the bytes exactly as they arrived
.digest("hex");
const a = Buffer.from(expected);
const b = Buffer.from(signature);
if (a.length !== b.length || !timingSafeEqual(a, b)) return false;
return Math.abs(Date.now() / 1000 - Number(parts.t)) <= maxAgeSeconds;
}
const app = express();
// TikTok to your own developer app: the app secret, part s
app.post("/webhooks/tiktok", express.raw({ type: "application/json" }), (req, res) => {
if (!verifySignature(req.body, req.get("tiktok-signature"), process.env.TIKTOK_APP_SECRET, "s")) {
console.warn("TikTok signature rejected, x-tt-logid:", req.get("x-tt-logid"));
return res.sendStatus(401);
}
res.sendStatus(200); // acknowledge first: TikTok retries anything but a 200
enqueue(req.body.toString("utf8")); // its content field is itself a JSON string
});
// easyCoexistence to your endpoint: the account's whsec_ secret, part v1
app.post("/webhooks/easycoexistence", express.raw({ type: "application/json" }), (req, res) => {
if (!verifySignature(req.body, req.get("x-ec-signature"), process.env.EC_SIGNING_SECRET, "v1")) {
return res.sendStatus(401);
}
res.sendStatus(200);
enqueue(req.body.toString("utf8")); // platform, account_id, external_id, entry
});delivery එකක් ප්රතික්ෂේප කිරීමට පෙර එය කොපමණ පැරණි විය හැකිද?
TikTok කප්පාදුව ලබන්නාට භාර දෙයි. ඔබේ ඔරලෝසුව සහ t අතර පරතරය ගණනය කර, එය ඉවසිය හැකිද යන්න තීරණය කරන්න, එහි guide එක කියයි. එහි Node sample එක තත්පර 5ක් ඉඩ දෙයි. එය තරම් තදින්, තත්පර කිහිපයකින් ඔරලෝසුව වරදින server එකක් නිවැරදි deliveries ප්රතික්ෂේප කළ හැක. ඉහත කේතය 300ට ඉඩ දෙයි, easyCoexistence එහි ස්වකීය forwards සඳහා receivers ට භාවිත කරන ලෙස ඉල්ලන කවුළුව. t වෙතින් මනින්න, එනම් signature ආවරණය කරන delivery වේලාව. body හි create_time වෙතින් නොමැනිය, එය event එක සිදු වූ වේලාව දක්වයි. TikTok sample එකේ t, create_time ට තත්පරයක් පසුව වැටේ.
endpoint එක කුමක් ප්රතිචාර දිය යුතුද?
signature එක නිවැරදි වූ වහාම 200, පසුව කාර්යය සිදු කරමින්, මන්ද TikTok වෙනත් ඕනෑම status එකක් අසාර්ථක delivery එකක් ලෙස සලකා නැවත යවයි. signature එක නොගැලපෙන විට, TikTok හි sample එක 4xx status එකකින් පිළිතුරු දෙන අතර x-tt-logid header එක log කරයි. එය TikTok වෙත ගැටලුවක් වාර්තා කළ විට request එක හඳුනා ගනී. body හි client_key එක යෙදුම නම් කරයි, එබැවින් එය ඔබේම යෙදුමේ ID සමඟ සංසන්දනය කිරීම සරල දෙවන පරීක්ෂාවක් වේ.
callback URL එක ලියාපදිංචි කරන්නේ කෙසේද, එය සත්යාපනය කරනවාද?
එක API call එකකින්. TikTok URL එක මුලින් පරීක්ෂා කරන challenge request එකක් ලේඛනගත කර නැත. POST /business/webhook/update/ ලබා ගන්නේ app_id, secret, event_type සහ HTTPS callback_url ය: publishing events සඳහා VIDEO, comment.update සඳහා COMMENT, සහ Mentions API මත brand.mention.event සඳහා BRAND_MENTION. ඒවා සියල්ලම එකම ආකාරයට අත්සන් කර පැමිණේ. GET /business/webhook/list/ මගින් event type එකක් සඳහා ලියාපදිංචි URL එක පෙන්වයි. මූලාරම්භය ඔප්පු කරන්නේ සෑම delivery එකක signature එකයි.
easyCoexistence forward කරන events මත Tiktok-Signature පරීක්ෂා කළ හැකිද?
බැහැ, ඒ සඳහා අවශ්යතාවක්ද නැත. TikTok එම deliveries අත්සන් කරන්නේ easyCoexistence හි ස්වකීය developer යෙදුමේ secret එකෙන්. එය කිසිදු tool එකක් හෝ API එකක් ලබා නොදේ. easyCoexistence සෑම event එකක්ම පැමිණෙන විට එම signature එක පරීක්ෂා කරයි. අසමත් වන එකකට 401 පිළිතුරු දෙයි. client_key වෙනත් යෙදුමක් නම් කරන body එකක් නොසලකා හරියි. ඉන්පසු ඔබට යවන forward එක X-EC-Signature හි, සම්බන්ධිත එම ගිණුමේ signing secret එකෙන් අත්සන් කරයි.
easyCoexistence තම forward කරන දේ අත්සන් කරන්නේ කෙසේද?
X-EC-Signature header එකෙන්, t=<unix>,v1=<hex>. මෙහි t යනු forward කළ වේලාවයි, v1 යනු t, තිත සහ body එක හරියටම යවන ලෙස හෙක්ස් HMAC-SHA256 එකයි. යතුර ගිණුමේ signing secret එකයි, whsec_ ට පසු අක්ෂර 32ක්, සම්පූර්ණයෙන්ම, prefix ඇතුළුව භාවිත කරයි. එහි ස්වකීය headers අතරින්, easyCoexistence සකසන්නේ Content-Type සහ මෙය පමණි, event header එකක් නොමැතිව. එබැවින් event නාමය entry.event වෙතින් කියවන්න:
POST https://hooks.example.com/tiktok/
Content-Type: application/json
X-EC-Signature: t=1793318405,v1=<HMAC_SHA256_HEX>
{"platform":"tiktok","account_id":"<ACCOUNT_ID>","external_id":"<TIKTOK_OPEN_ID>","entry":{"event":"comment.update","create_time":1793318400,"content":{...}}}
v1 = hex(HMAC-SHA256(key = "whsec_<SECRET>", message = "1793318405." + raw body))signing secret එක ප්රතිස්ථාපනය කළ විට කුමක් වේද?
නව secret එක ඊළඟ forward එකේ සිට අත්සන් කරයි. set_social_webhook_destination හෝ PUT /channels/{id}/webhook නැවත කැඳවීමෙන් නව secret එකක් ලබා දෙන අතර පැරණි එක වහාම ඉවත් කරයි. සෑම forward එකක්ම එක් වරක් පමණක් යවන බැවින්, මාරුව අතරතුර ඔබේ server එක ප්රතික්ෂේප කරන event එකක් නැති වේ. නව secret එක deploy වන මිනිත්තු කිහිපයක් දෙකම පිළිගන්න. channels සහ posts ගැන status events වෙනත් secret එකක් භාවිත කරයි. එය Dashboard, Profile, Developers යටතෙන් ලබා ගන්නා එකයි. ඒවා X-EC-Event සහ X-EC-Delivery headers සමඟ පැමිණේ, පැය 33ක් පමණ නැවත උත්සාහ කෙරේ.
සාමාන්ය වැරදි
- framework එක දැනටමත් parse කළ body එකක් සත්යාපනය කිරීම. JSON middleware එක object එකක් ලබා දෙයි, එය නැවත serialize කිරීමෙන් TikTok හි bytes වෙනස් විය හැකිය. webhook route මත raw body කියවන්න.
- signature එක අසමත් වූ delivery එකකට 200 පිළිතුරු දීම. TikTok එක event එකකට 200 දුටු පසු එය යැවීම නවත්වයි, එබැවින් වැරදි ලෙස සකසන ලද පරීක්ෂාවක් මගින් ප්රතික්ෂේප කළ සැබෑ event එකක් නැති වේ. 4xx නම් TikTok පැය 72ක් දක්වා නැවත උත්සාහ කරයි.
- signatures === මගින් සංසන්දනය කිරීම, TikTok හි sample එක කරන ලෙසම. timingSafeEqual වැනි නියත කාලීන සංසන්දනයක් ව්යාජ signature එකක් කොපමණ ගැලපුණාදැයි හෙළි නොකරයි.
- easyCoexistence හි secret එක Base64 decode කිරීම හෝ එහි whsec_ prefix කපා දැමීම. HMAC යතුර එක වරක් පෙන්වූ විදියටම, සම්පූර්ණ string එකයි.
ඉන්පසු සම්බන්ධිත ගිණුමේ comment events ඔබේ HTTPS endpoint වෙත forward කරයි, ඒවා X-EC-Signature හි අත්සන් කර, එක් ගිණුමකට පමණක් අදාළ secret එකකින්. endpoint එක Claude හෝ ChatGPT වෙතින් set_social_webhook_destination මගින්, හෝ PUT /channels/{id}/webhook සමඟ සකසන්න. සම්බන්ධතාවයකට මාසිකව US$ 9 සිට US$ 0.75 දක්වා, සම්බන්ධතා එක් කරන ගණනට අනුව අඩු වෙමින්, පළමු දින 3 නොමිලේ.
නිතර අසන ප්රශ්න
x-tt-logid TikTok webhook එකක් තුළ කුමක් ද?
එක් delivery එකක අනන්ය ID එක ගෙන යන header එකකි. TikTok එය log කිරීමට ඉල්ලයි, මන්ද TikTok වෙත ගැටලුවක් වාර්තා කළ විට එය request එක හඳුනා ගනී.
TikTok නව webhook URL එකක් සත්යාපනය කිරීමට challenge එකක් යවනවාද?
TikTok හි API for Business සඳහා ඒවා ලේඛනගත කර නැත. /business/webhook/update/ call එක URL එක ලියාපදිංචි කරයි. ඉන්පසු deliveries Tiktok-Signature සමඟ පැමිණේ, ඔබේ server එකට පරීක්ෂා කිරීමට.
මගේ TikTok webhook signature කිසිවිටක නොගැලපෙන්නේ ඇයි?
input සහ key පරීක්ෂා කරන්න. HMAC එකට t, තිත සහ raw body එක ලැබුණු ආකාරයටම ආවරණය කළ යුතුය, යෙදුමේ secret එක භාවිත කළ යුතුය, සහ සංසන්දනය කළ යුතු වන්නේ සම්පූර්ණ header එක නොව s= ට පසු අගයයි.
easyCoexistence මගින් forward කරන TikTok events මම කෙසේ සත්යාපනය කරන්නද?
X-EC-Signature සහ destination සකසන විට පෙන්වන signing secret එක සමඟ: t, තිත සහ raw body මත HMAC-SHA256 නැවත ගණනය කරන්න, එය v1 සමඟ සංසන්දනය කරන්න, සහ මිනිත්තු 5කට වඩා පැරණි t ප්රතික්ෂේප කරන්න.
තවදුරටත් කියවන්න
ඔබේ පළමු channel එක මිනිත්තු දෙකකින් සම්බන්ධ කරන්න.
වේදිකා සමාලෝචන සඳහා බලා සිටීමට අවශ්ය නැත. WhatsApp, Instagram, TikTok හෝ වෙනත් channel එකක් සම්බන්ධ කර, පසුව ඔබේ AI හට පළ කිරීමට, ප්රතිචාර දැක්වීමට හෝ වාර්තා කිරීමට පවසා එය වැඩ කරන ආකාරය බලන්න.
- දින 3ක් නොමිලේ
- ඕනෑම වේලාවක අවලංගු කරන්න
- නිල API පමණි
- 24/7 නිරීක්ෂණය කෙරේ
සත්යාපනය කළේ