رفتن به محتوا
راهنمای API

وب‌هوک‌ها

نمایش به‌صورت Markdown به‌روزرسانی‌شده

به‌جای polling، برای یک اجرا webhook_url تعیین کنید. وقتی درخواست به وضعیت نهایی (succeeded، failed یا canceled) برسد، یک POST امضاشده به آن URL ارسال می‌کنیم.

ترمینال
curl -X POST "https://api.doitong.com/v1/run/{model_id}?webhook_url=https://example.com/hooks/doitong" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "..."}'

رویداد

سرصفحه‌های درخواست
POST /hooks/doitong HTTP/1.1
Content-Type: application/json
User-Agent: Doitong-Webhooks/1
Doitong-Request-Id: req_8k2m4q7x1z9c3v5b6n0p2r4t
Doitong-Signature: t=1760961609,v1=5f1c0d6e2b…
بدنهٔ درخواست
{
  "id": "evt_8k2m4q7x1z9c3v5b6n0p2r4t_succeeded",
  "object": "event",
  "type": "request.succeeded",
  "created_at": "2026-10-20T12:00:09Z",
  "data": {
    "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "object": "request",
    "status": "succeeded",
    "outputs": [ { "type": "video", "url": "https://content.doitong.com/dev-api/…/0-output.mp4" } ]
  }
}
  • type برابر با request.succeeded، request.failed یا request.canceled است.
  • data شیء کامل درخواست است؛ دقیقاً همان چیزی که GET /requests/{id} برمی‌گرداند.
  • id برای یک درخواست و وضعیت نهایی آن ثابت است. از آن برای نادیده‌گرفتن تحویلی که قبلاً پردازش کرده‌اید استفاده کنید.

تحویل‌ها و تلاش‌های مجدد

در عرض 10 ثانیه با هر وضعیت 2xx پاسخ دهید. هر چیز دیگری (یا timeout) دوباره تلاش می‌شود: در مجموع حداکثر 6 تلاش، پس از 30 ثانیه، 2 دقیقه، 10 دقیقه، 1 ساعت و 6 ساعت. کارهای زمان‌بر را بعد از پاسخ انجام دهید، نه قبل از آن.

اعتبارسنجی امضا

هر کلید، secret امضای مخصوص خود را دارد. آن را یک‌بار از GET https://api.doitong.com/v1/account (webhook_signing_secret؛ با whsec_ شروع می‌شود) بخوانید و در کنار کلید ذخیره کنید.

سرصفحهٔ Doitong-Signature به شکل t=<unix time>,v1=<signature> است؛ امضا، HMAC-SHA256 هگزادسیمال "<t>.<raw request body>" است که secret شما به‌عنوان کلید آن استفاده می‌شود. برای اعتبارسنجی:

  1. بایت‌های بدنهٔ خام را دقیقاً همان‌طور که دریافت شده‌اند بردارید (پیش از هرگونه تجزیهٔ JSON).
  2. HMAC-SHA256 عبارت t + "." + body را با secret خود و به‌صورت هگزادسیمال کوچک محاسبه کنید.
  3. آن را با v1 در زمان ثابت مقایسه کنید.
  4. اگر t بیش از 5 دقیقه با ساعت شما اختلاف دارد، رویداد را رد کنید (محافظت در برابر replay).

یک receiver کامل در Node.js (Express) و Python (Flask):

import crypto from "node:crypto";
import express from "express";

const SECRET = process.env.DOITONG_WEBHOOK_SECRET; // whsec_...
const app = express();

app.post("/hooks/doitong", express.raw({ type: "application/json" }), (req, res) => {
  const header = req.get("Doitong-Signature") || "";
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=", 2)));
  const t = Number(parts.t);
  const expected = crypto.createHmac("sha256", SECRET).update(t + "." + req.body).digest("hex");
  const given = Buffer.from(parts.v1 || "", "utf8");
  const valid =
    given.length === expected.length &&
    crypto.timingSafeEqual(given, Buffer.from(expected, "utf8")) &&
    Math.abs(Date.now() / 1000 - t) < 300;
  if (!valid) return res.status(400).send("bad signature");

  const event = JSON.parse(req.body);
  if (event.type === "request.succeeded") {
    console.log(event.data.id, event.data.outputs.map((o) => o.url));
  }
  res.sendStatus(204);
});

نکته‌ها

  • سریع پاسخ دهید و پردازش خود را در صف قرار دهید.
  • secret متعلق به کلید API است که اجرا را آغاز کرده است. کلیدهای سرویس‌های مختلف secretهای متفاوتی دارند.