تخطَّ إلى المحتوى
AR
الحصول على مفتاح API
تصفح الوثائق

الأدلة

حجم العمل المدفوع من FlashData

تشغيل تطبيقك أو وكيل وكيل CLI المهام الموكلة إلى Linux أو Dockerثم التحقق من الوصول والنتيجة إعادة الاستخدام بعد العودة.

في هذه الصفحة

1. اختر وقت الجري

استخدم مضيف Linux مع Bash وjq ومفتاح API للمالك بصلاحية google_search. نفّذ الإعداد بمستخدم نظام التشغيل الذي سيشغّل المهمة. أنشئ مجلد المهام الخاص هذا للخطوات 1–4؛ وتُظهر تسميات الملفات أي مجلدات فرعية.

إنشاء ملف المهمة
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"

Install the native CLI أولاً اديروا القيادة -في (ففيلداتا) لإيجاد طريقها المطلق، ثم وضعوا FLASHDATA_BIN إلى ذلك الطريقِ في runtime.sh. ضعي اسم الملف ومسار الولاية الدائم مرة هنا، ثم أنقذي الملف.

runtime.sh
# runtime.sh — edit the executable and persistent state paths.
export FLASHDATA_BIN=/usr/local/bin/flashdata
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"

run_flashdata() {
  env -u FLASHDATA_API_KEY "$FLASHDATA_BIN" "$@" \
    --profile "$FLASHDATA_PROFILE" \
    --state-dir "$FLASHDATA_STATE_DIR"
}

تحققوا من وقت التشغيل المختار

اهرب من ملف المهمة run_flashdata هو المساعد الذي أنقذه runtime.sh; All later commands use its profile and state directory. وهو يتجاهل FLASHDATA_API_KEY حتى لا يمكن لمفتاح البيئة أن يحل محل الملف المنقذ. توقع نسختي CLI و jq.

إعداد الدولة الدائمة؛ عدم وجود استفسار من شركة API
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version

2. دخول المالك مرة واحدة

إذا كان الملف لديه بالفعل وصول للمالك، تخطى الاستيراد وإداره الشيك أسفل. وإلا، جهزوا ملفاً سرياً للمالكين يقرأه مستعمل الخدمة ويستبدلون الطريق المثالي بموقعه. ويقرأه الاستيراد من خلال stdin؛ Docker لا ينسخها في الصورة.

نقطة إلى الملف السري المنشور
export FLASHDATA_KEY_FILE='/run/secrets/flashdata_api_key'
الاستيراد والتحقق في وقت التشغيل المختار
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Set the path to your mounted owner-key secret}"
run_flashdata auth login --api-key-stdin --non-interactive \
  < "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactive

تأكيد الحساب والإذن

ويطبع الشيك الحساب ID، والمصادر المسموح بها وحماية الإبداع، ثم true. تأكد من أن الحساب ID هو المالك المقصود قبل الاستمرار، ويبقى access.json في ملف المهمة لأغراض التفتيش.

تأمين دخول المالك مجاناً
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata auth status --json --non-interactive > access.json
jq '{accountId: .data.identity.identity.accountId,
     sources: .data.identity.permittedSources,
     credentialProtection: .data.credentialProtection}' access.json
jq -e '.ok and .data.accessVerified
  and (.data.identity.identity.recurringAllowed == true)
  and (.data.identity.permittedSources | index("google_search") != null)' access.json

تخزين الوثائق وملفاتها الثابتة

Inspect data.credentialProtection in auth status. ويمكن أن تستخدم شركة Linux جهازاً سرياً غير مقفل؛ ويمكن للمضيف الذي لا رأس له أو الحاوية المذكورة أعلاه أن يستخدم ملفاً للمدعوين فقط. أبقي دليل الولاية خاص ومستمر زود المستعمل المنتشر على انفراد من ملفك المحمول

استمرالموقع
وثائق التفويض والادارة اليوميةFLASHDATA_STATE_DIR
المدخلات والإيصالات والنتائجThe task folder; mounted as /work in Docker.

3. تقييم الطلب والتكلفة

انقذوا request.json بجانبك runtime.sh. ويتحقق الشيك التالي من تكرار الوصول والطلب، ويقرأ التسعير الحالي ويقارنه بالرصيد المتاح. وهي لا تقدم أي بحث ولا تحتفظ بأرصدة دائنة. استمري فقط عندما تطبع التصفية true.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
تحقق قبل أول مهمة مدفوعة الأجر
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata account balance --json --non-interactive > balance.json
run_flashdata query --input request.json --mode realtime --dry-run --recurring \
  --run-id deployment-first-task --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
  .ok and .data.dryRun and .data.estimateAvailable
  and ($balance[0].ok == true)
  and any(.data.estimate.prices[]?;
    .source == "google_search" and .available == true
    and (.estimatedCredits | type == "number")
    and ($balance[0].data.availableCredits | type == "number")
    and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json

4. تشغيل مرة واحدة والتحقق من إعادة الاستخدام

انقذوا deployment-check.sh أسفل. مع عملية نشر جديدة IDويُقدم التنفيذ الأول بحثاً مدفوعاً؛ أما الثاني فيبدأ عملية جديدة ويقرأ النتيجة الموفرة. إذا كان هذا ID وقد اكتملت بالفعل في نفس الصورة، وكلاهما يحاول إعادة استخدامها.

Save deployment-check.sh

أنشئ deployment-check.sh بجانب runtime.sh وrequest.json داخل مجلد المهام الخاص على المضيف. انسخ السكربت الكامل أدناه إليه واحفظه.

deployment-check.sh
#!/usr/bin/env bash
set -euo pipefail
umask 077
cd -- "$(dirname -- "$0")"
. ./runtime.sh
attempt=$(mktemp -d ./deployment-check.XXXXXX)
printf 'Attempt files: %s\n' "$attempt" >&2
cp -- request.json "$attempt/request.json"
if ! run_flashdata query --input "$attempt/request.json" --mode realtime --recurring \
  --run-id deployment-first-task --timeout 2m --json --non-interactive \
  --output "$attempt/result.json" \
  > "$attempt/receipt.json" 2> "$attempt/error.json"; then
  cat "$attempt/error.json" >&2
  exit 1
fi
jq -e '.ok == true' "$attempt/receipt.json" >/dev/null
jq -e '.source == "google_search" and .status == "done"
  and (.results[0].organic | type == "array")' "$attempt/result.json" >/dev/null
jq '{runId, cached, usage}' "$attempt/receipt.json"
printf 'Saved result: %s\n' "$attempt/result.json"

اجري الشيك المنقذ مرتين

اهرب من ملف المهمة المستضيف مثل نفس مستعمل الخدمة Both processes load the runtime.sh save in step 1.

اركضي، ثم اعيدي العملية
# A new run ID submits one paid search; a completed ID reuses its result.
bash deployment-check.sh

# New process; Docker uses a new container with the same mounts.
# Same account, input and state: cached: true, no new search.
bash deployment-check.sh

يُصدّر الإيصال الثاني

للركض الجديد، نتوقع cached: false، ثم cached: true. وتطبع كل محاولة ملفها من طراز deployment-check.XXXXXX، وتحتفظ برقم request.json و receipt.json و error.json، بالإضافة إلى result.json على النجاح. التسلّم المكبوّل يُبلغ عن الاستخدام الأصلي. محاولة فاشلة تبقي ملفاتها للتعافي

الاستلام الثاني: مقتطف
{
  "ok": true,
  "runId": "deployment-first-task",
  "cached": true
}

اقرأ نتائج البحث المنقذ

المجموعة ATTEMPT_DIR إلى المجلد الثاني الناجح الذي مطبوع أعلاه، مثل التصدير ATTEMPT_DIR='./deployment-check.ABC123'. هذه الأوامر تقرأ الملفات المحلية فقط

وصلات الاستلام والمصدر
# Use one attempt folder printed by deployment-check.sh.
: "${ATTEMPT_DIR:?Set a saved deployment-check.XXXXXX folder}"
jq '{runId, cached, usage}' "$ATTEMPT_DIR/receipt.json"
jq '.results[0].organic[] | {title, link, snippet}' "$ATTEMPT_DIR/result.json"

الانتقال من التحقق من النشر إلى مهمة متكررة

هذه الشيكة لديها جهاز ثابت من طراز ID. وللعمل المتكرر، يُعطي كل واحد من الحالات التي يُعتزم القيام بها مُحدداً لها، مُحدداً برقم ID، ويحتفظ بالزمن المُختار، والحساب، وقطعة المدخلات، ومبالغ الدولة. أوافق على طلب المهرب المتكرر لاستخدامه run_flashdata هكذا Docker المهام تبقى داخل الحاوية

تحقق من الوصول من إجراءات GitHub

استخدموا جهازاً ثابتاً من طراز Linux مع Bash، jq، وجهاز تصنيف (CLI) تم تركيبه بالفعل تحت مستعمل الـ (جرينر OS). احفظ هذا التدفق في مستودع طلبك ويتحقق من مضيف شركة CLI دون القيام بمهمة مدفوعة الأجر.

  1. أرسلي بطاقة (فلادداتا) إلى ذلك الهارب.
  2. وضع متغيرات مستودعات FLASHDATA_BIN و FLASHDATA_STATE_DIR إلى مساراتها المطلقة، و FLASHDATA_PROFILE إلى اسم الملف المركب.
.github/workflows/flashdata-check.yml
name: FlashData access check
on: workflow_dispatch
permissions: {}
concurrency:
  group: flashdata-research
  cancel-in-progress: false
jobs:
  verify:
    runs-on: [self-hosted, linux, flashdata-research]
    timeout-minutes: 5
    steps:
      - name: Verify the installed profile without a paid query
        shell: bash
        env:
          FLASHDATA_BIN: ${{ vars.FLASHDATA_BIN }}
          FLASHDATA_STATE_DIR: ${{ vars.FLASHDATA_STATE_DIR }}
          FLASHDATA_PROFILE: ${{ vars.FLASHDATA_PROFILE }}
          FLASHDATA_API_KEY: ""
        run: |
          set -euo pipefail
          : "${FLASHDATA_BIN:?Set the absolute CLI path}"
          : "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
          : "${FLASHDATA_PROFILE:?Set the installed profile name}"
          test -d "$FLASHDATA_STATE_DIR"
          "$FLASHDATA_BIN" auth status --profile "$FLASHDATA_PROFILE" \
            --state-dir "$FLASHDATA_STATE_DIR" --json --non-interactive |
            jq -e '.ok and .data.accessVerified
              and (.data.identity.identity.recurringAllowed == true)
              and (.data.identity.permittedSources | index("google_search") != null)'

افحصي الشيك

بعد حفظ سير العمل في الفرع الافتراضي للمستودع، افتح Actions → FlashData access check → Run workflow. توقّع true وفحصًا ناجحًا. يفشل التنفيذ عند غياب الوصول أو الصلاحية دون إرسال بحث.

أبقوا الإعدام في الولاية عبر الوظائف

الركض الفموي يبدأ بدون المجلة الأصلية استخدام دولة تطبيق دائمة أو حاكم ثابت للعمل المتكرر المدفوع الأجر. إعادة تركيب المفتاح فقط لا يمكن تحديد رسالة وظيفة سابقة. إبقاء دليل الدولة ونواتج العمل خاصة؛ لا تحميلها على أنها مصنوعات يدوية من طراز CI.

تناوب أو إلغاء إمكانية الوصول إلى الموقع

أوقف الإرسال مؤقتًا. داخل مجلد المهمة، وجّه FLASHDATA_KEY_FILE إلى مفتاح بديل للحساب نفسه والمصادر المطلوبة، ثم شغّل الأوامر أدناه. أعد فحص الوصول وdeployment-check.sh؛ وتوقّع cached: true. ألغِ المفتاح القديم بعد التحقق واحتفظ بالملف الشخصي ودليل الحالة.

يستعاض عن المفتاح برقم stdin
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Point to the mounted replacement key for the same account}"
run_flashdata auth login --replace --api-key-stdin --non-interactive \
  < "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactive

توقف عن الدخول

أوقفوا الجدول، ألغيوا الإتصال بالمفتاح أو العميل في النقابة، ثم أعيدوا التحقق من الدخول المجاني يجب أن تفشل ولا يلغى نظام النقل المحلي وحده عقيدة الخادم؛ ولا تزال الملفات المصدرة بالفعل على أقراص.

عمليات التحقق من النشر التي تفشل

الرمزFix
لم يتم العثور على القيادة/نسخة خاطئة من CLIتحقق من أمر القيادة - V flashdata و FLASHDATA_BIN في runtime.sh. For Dockerإعادة بناء و تشغيل الصورة --version تحقق.
المبلغ المفقود أو الإذن الممنوحأنشئ مجلدي الحالة والمهام على مضيف Docker، بملكية UID/GID الخاصين بالخدمة. احتفظ بمساريهما ثابتين.
replacement_requires_flagالملف لديه مفتاح مختلف منقذ التحقق من إمكانية الوصول القائمة أولاً؛ استخدام إجراء التناوب لاستبدال معتزم.
لا يمكن فك التشفيرتشغيل مثل المستعمل الذي زوده، في نفس بيئة المخزن الإبداعي. توفير إمكانية الوصول إلى وجهة جديدة بدلا من نسخ ملف محمول مشفر.
عائدات التحقق من التكاليف falseInspect balance.json and preflight.json. (ب) اشتراط السعر المتاح، وإذن المصدر، والتوازن الكافي قبل تقديم الطلب.
run_account_mismatchتحقق من الحساب المختار وعناوين API الأصلية. استعد الوصول الأصلي؛ ولا تعِد تسمية التنفيذ لتجاوز الاستعادة.
run_id_input_conflictإعادة الطلب الأصلي من المحاولة request.json. (أ) استخدام طائرة جديدة من طراز ID فقط لمهمة جديدة مدفوعة.
CI يَبْقى مَسْتُولَتحقق من أن الهارب على الإنترنت ولديه كل بطاقة تشغيلية ويتطلب تدفق العمل هذا راكضاً من طراز Linux ذاتياً باستمرار.