सीधे सामग्री पर जाएँ
HI
API कुंजी प्राप्त करें
दस्तावेज़ देखें

API संदर्भ

पूर्णता वेबहुक्स

असिंक, बैच और Bulk पूर्णता सूचनाएँ प्राप्त करें, डुप्लिकेट हटाएँ और सत्यापित करें।

इस पेज पर

callback_url कॉन्फ़िगर करें

असिंक क्वेरी, बैच एंट्री या Bulk जॉब सबमिट करते समय पोर्ट 443 पर एक सार्वजनिक HTTPS callback_url प्रदान करें (अधिकतम 2,048 वर्ण, बिना क्रेडेंशियल या URL फ्रैगमेंट के)। सूचनाएँ बंद करने के लिए callback_url न दें या null अथवा खाली स्ट्रिंग भेजें।

असिंक और बैच अनुरोधों (POST /v1/queries और POST /v1/queries/batch) के लिए, callback_url को params के बाहर क्वेरी ऑब्जेक्ट के शीर्ष स्तर पर रखें। Bulk जॉब (POST /v2/bulk-jobs) के लिए, callback_url को options के बाहर शीर्ष स्तर पर रखें।

callback_url के साथ असिंक क्वेरी
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  },
  "callback_url": "https://example.com/webhooks/flashdata"
}
callback_url के साथ Bulk जॉब
{
  "source": "youtube_metadata",
  "callback_url": "https://example.com/webhooks/flashdata",
  "options": {
    "include_formats": false
  }
}

सहेजे गए कॉलबैक URL बनाम प्रति-अनुरोध callback_url

Management API कंसोल-प्रबंधित सहेजे गए कॉलबैक URL को /v2/delivery/webhooks (cookieSession + csrfToken) पर भी उपलब्ध कराता है, जिससे पुन: उपयोग योग्य गंतव्य सहेजे जा सकते हैं और POST /v2/delivery/webhooks/{webhookId}/test से परीक्षण पेलोड भेजा जा सकता है। प्रोग्रामेटिक API एकीकरण को प्रत्येक सबमिशन में सीधे callback_url भेजना चाहिए।

इवेंट पेलोड और हेडर

सूचनाएँ पुष्टि करती हैं कि जॉब completed या failed स्थिति में पहुँच गया है (या Bulk मैनिफ़ेस्ट प्रकाशित हो गया है)। पेलोड में कभी भी क्वेरी परिणाम, मीडिया फ़ाइलें या आपकी API कुंजी नहीं होती। delivery_id (जो X-Delivery-Id हेडर में भी भेजा जाता है) से डिलीवरी डुप्लिकेट हटाएँ।

फ़ील्डअर्थ
delivery_idआइडेम्पोटेंट डुप्लिकेट हटाने के लिए स्थिर डिलीवरी पहचानकर्ता; X-Delivery-Id हेडर से मेल खाता है।
idजॉब या Bulk जॉब पहचानकर्ता। सबमिशन के समय सहेजी गई रसीद से मिलान करें।
sourceअनुरोधित डेटा स्रोत (जैसे google_search या youtube_download)।
statusअंतिम स्थिति: असिंक/बैच के लिए completed या failed; मैनिफ़ेस्ट प्रकाशन के बाद Bulk के लिए completed।
linksप्रमाणीकृत Management API स्थिति और परिणाम लिंक। परिणाम लाने से पहले हमेशा API के माध्यम से सत्यापित करें।
असिंक / बैच पूर्णता इवेंट
{
  "delivery_id": "dlv_01JEXAMPLE0000000000000000",
  "id": "job_01JEXAMPLE0000000000000000",
  "source": "google_search",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/jobs/job_01JEXAMPLE0000000000000000",
      "method": "GET"
    },
    {
      "rel": "results",
      "href": "https://api.flashdata.dev/v2/jobs/job_01JEXAMPLE0000000000000000/results",
      "method": "GET"
    }
  ]
}
Bulk पूर्णता इवेंट
{
  "delivery_id": "dlv_01JEXAMPLE0000000000000001",
  "id": "bulk_01JEXAMPLE0000000000000000",
  "source": "youtube_metadata",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/bulk-jobs/bulk_01JEXAMPLE0000000000000000",
      "method": "GET"
    },
    {
      "rel": "manifest",
      "href": "https://api.flashdata.dev/v2/bulk-jobs/bulk_01JEXAMPLE0000000000000000/manifest",
      "method": "GET"
    }
  ]
}

पुनः प्रयास, सत्यापन और रिसीवर सुरक्षा

पहले प्रयास सहित डिलीवरी घातीय बैकऑफ़ के साथ कुल आठ बार तक प्रयास करती है। delivery_id सहेजने के बाद तुरंत 2xx प्रतिक्रिया लौटाएँ।

वेबहुक इवेंट अनसाइन होते हैं। पेलोड URL पर आँख मूँदकर भरोसा न करें और न ही किसी अज्ञात होस्ट को कॉल करें: id और source का अपनी सहेजी गई रसीद से मिलान करें, X-API-Key के साथ GET /v2/jobs/{id} या GET /v2/bulk-jobs/{bulkId} से स्थिति सत्यापित करें, और फ़ॉलबैक के रूप में पोलिंग बनाए रखें।

न्यूनतम Node.js वेबहुक रिसीवर
import http from "node:http";

const seen = new Set(); // Replace with durable database storage in production.

http.createServer((req, res) => {
  if (req.method !== "POST" || req.url !== "/webhooks/flashdata") {
    res.writeHead(404).end();
    return;
  }
  const chunks = [];
  req.on("data", chunk => chunks.push(chunk));
  req.on("end", () => {
    const event = JSON.parse(Buffer.concat(chunks).toString("utf8"));
    const deliveryId = String(req.headers["x-delivery-id"] ?? event.delivery_id ?? "");
    if (!deliveryId || seen.has(deliveryId)) {
      res.writeHead(200).end("ok");
      return;
    }
    seen.add(deliveryId);
    // Queue background verification against https://api.flashdata.dev/v2/jobs/{id}
    // or /v2/bulk-jobs/{id} with X-API-Key; ignore unverified URLs in event.links.
    res.writeHead(200).end("accepted");
  });
}).listen(3000);
Markdown