الويب هوك

نظرة عامة

بدلًا من الاستعلام عن GET /jobs/{id} بشكل متكرر، يمكنك توفير رابط ويب هوك لتلقّي طلب POST عند اكتمال المهمة. هذا أكثر كفاءة ويُقلل من مكالمات API غير الضرورية.

استخدام الويب هوك

أضف رأس X-Webhook-URL إلى أي طلب توليد. عندما تصل المهمة إلى حالة نهائية (مكتملة أو فاشلة أو ملغاة)، سترسل واجهة API طلب POST إلى رابطك يحتوي على بيانات المهمة الكاملة.

// npm install @krea-ai/sdk
import { Krea } from "@krea-ai/sdk";

const krea = new Krea({ apiKey: process.env.KREA_API_KEY });

const job = await krea.image(
  "bfl/flux-1-dev",
  {
    prompt: "a serene mountain landscape at sunset",
    width: 1024,
    height: 576
  },
  { webhookUrl: "https://your-server.com/webhook" }
);

console.log(`Job ID: ${job.job_id}`);
// Your webhook will receive the results when complete

حمولة الويب هوك

عند اكتمال المهمة، يتلقى رابط الويب هوك طلب POST مع بيانات المهمة:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "created_at": "2025-01-15T10:30:00.000Z",
  "completed_at": "2025-01-15T10:30:05.000Z",
  "result": {
    "urls": ["https://..."]
  }
}

أفضل الممارسات

استجب بسرعة - أرجع رمز حالة 2xx على الفور. عالج بيانات الويب هوك بشكل غير متزامن عند الحاجة.

تحقق من الحمولة - تأكّد من أن job_id يطابق مهمة بدأتها قبل معالجة النتائج.

استخدم نقاط نهاية HTTPS للأمان
نفّذ آلية عدم التكرار لتفادي التسليمات المكررة
سجّل استلام الويب هوك لأغراض التصحيح