Chuyển đến nội dung
VI
Lấy khóa API
Duyệt tài liệu

Hướng dẫn

Triển khai FlashData Nạp công việc

Chạy ứng dụng hay tác nhân của bạn CLI tác vụ khi Linux hay Dockersau đó xác minh truy cập và sử dụng lại sau khi khởi động lại.

Trên trang này

1. Chọn thời gian chạy

Dùng a Linux máy Bash và jqvà một người chủ. API phím với google_search Cho phép. Chạy thiết lập dạng OS người dùng sẽ thực hiện tác vụ. Tạo thư mục tác vụ riêng này cho bước 1–4; nhãn tập tin hiển thị bất kỳ thư mục con.

Tạo thư mục tác vụ
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"

Cài đặt bản xứ CLI Đầu tiên. Chạy lệnh -v flashdata để tìm đường dẫn tuyệt đối của nó, sau đó đặt FLASHDATA_BIN con đường đi vào runtime.sh. Ở đây hãy đặt tên hồ sơ và đường dẫn trạng thái bền bỉ, rồi lưu tập tin.

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"
}

Kiểm tra giờ chạy đã chọn

Chạy khỏi thư mục tác vụ. run_flashdata là người giúp việc được cứu vào runtime.sh; tất cả các lệnh sau này sử dụng hồ sơ và thư mục quốc gia của nó. Nó bỏ qua FLASHDATA_API_KEY Vì vậy, một khóa môi trường không thể thay thế hồ sơ đã lưu. Mong đợi CLI và jq phiên bản.

Chuẩn bị tình trạng kiên trì, không API truy vấn
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version

2. Cài đặt quyền sở hữu một lần

Nếu hồ sơ đã có quyền sở hữu, bỏ qua nhập khẩu và kiểm tra bên dưới. Nếu không, gắn kết một tập tin mật mã chìa khóa chủ sở hữu có thể đọc được bởi người dùng dịch vụ và thay thế đường dẫn ví dụ với vị trí của nó. Thư nhập khẩu đọc qua stdin; Docker không sao chép nó vào ảnh.

Chỉ tới tập tin bí mật được triển khai
export FLASHDATA_KEY_FILE='/run/secrets/flashdata_api_key'
Nhập và xác minh trong thời hạn đã chọn
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

Xác nhận tài khoản và giấy phép

Kiểm tra in tài khoản IDĐược phép sử dụng nguồn lực và bảo vệ bằng chứng. true. Xác nhận tài khoản ID là chủ sở hữu đã định trước khi tiếp tục. access.json ở lại trong thư mục để kiểm tra.

Lưu truy cập chủ sở hữu « 2 » để kiểm tra tự do
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

Tập tin lưu trữ và lưu tạm văn bản

Kiểm tra data.credentialProtection trong auth status. Linux có thể sử dụng một dịch vụ mật vụ đã mở khóa; một máy không đầu hoặc hộp bên trên có thể sử dụng tập tin chỉ- phù hợp với người sở hữu. Giữ cho thư mục quốc gia được riêng tư và bền bỉ. Sắp xếp riêng người dùng đã được triển khai từ hồ sơ mã hóa của máy tính xách tay.

GiữĐịa điểm
Giấy chứng nhận và chạy nhật kýFLASHDATA_STATE_DIR
Nhập, biên lai và kết quảThư mục tác vụ; đã được gắn như /work in Docker.

3. Kiểm tra lại yêu cầu và chi phí

Cứu request.json bên cạnh runtime.sh. Kiểm tra sau đây xác nhận quyền truy cập và yêu cầu, đọc giá trị hiện tại và so sánh với sự số dư sẵn có. Nó không gửi tín dụng tìm kiếm và không lưu lại tín dụng. Chỉ tiếp tục khi in bộ lọc true.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Kiểm tra trước khi bắt đầu nhiệm vụ lương
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. Chạy một lần và xác nhận tái sử dụng

Lưu deployment-check.sh bên dưới. Với một cuộc triển khai đầu tiên IDViệc thi hành án tử hình đầu tiên được trả tiền để tìm kiếm; người thứ hai bắt đầu một tiến trình mới và đọc kết quả đã được cứu. Nếu thế này. ID Đã hoàn thành trong cùng hồ sơ, cả hai cố gắng tái sử dụng nó.

Lưu deployment-check.sh

Tạo deployment-check.sh bên cạnh runtime.sh và request.json trong thư mục tác vụ cá nhân trên máy. Sao chép toàn bộ văn lệnh bên dưới vào nó và lưu nó vào.

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"

Kiểm tra lại lần nữa

Chạy từ thư mục tác vụ máy đó là cùng một người dùng dịch vụ. Cả hai quá trình nạp các runtime.sh đã lưu trong bước 1.

Chạy, rồi khởi động lại tiến trình
# 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

Kiểm tra hóa đơn thứ hai

Để chạy một vòng mới, mong đợi cached: falseVậy thì... cached: true. Mỗi lần cố gắng in nó deployment-check.XXXXXX thư mục và lưu request.json, receipt.json và error.json, cộng result.json về thành công. Biên nhận lưu tạm báo cáo cách sử dụng gốc. Một nỗ lực thất bại giữ hồ sơ của nó để phục hồi.

Phần mở rộng nội dung thư mục chính
{
  "ok": true,
  "runId": "deployment-first-task",
  "cached": true
}

Đọc kết quả tìm kiếm đã lưu

Đặt ATTEMPT_DIR tới thư mục thành công thứ hai được in ở trên, chẳng hạn xuất khẩu ATTEMPT_DIR='./deployment-check.ABC123'. Những lệnh này chỉ đọc tập tin cục bộ.

Các liên kết & hoá đơn và nguồn
# 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"

Di chuyển từ kiểm tra triển khai sang một nhiệm vụ lặp lại

Kiểm tra này có cố định chạy ID. Để lặp lại công việc, hãy cho mỗi lần có ý định ID và giữ lại thời gian chạy đã chọn, tài khoản, hình ảnh nhập và gắn kết trạng thái. Chỉnh lại lệnh truy vấn của người chạy cần sử dụng run_flashdata Vì vậy Docker nhiệm vụ ở trong container.

Kiểm tra truy cập từ GitHub Hành động

Hãy tận dụng sự tin cậy, kiên trì Linux Chạy với Bash, jq và CLI hồ sơ đã được cài đặt dưới bộ chạy OS người dùng. Lưu luồng công việc này vào kho ứng dụng của bạn. Kiểm tra máy chủ. CLI Mà không phải làm một nhiệm vụ được trả tiền.

  1. Gán nhãn tìm kiếm kiểu flashdata cho người chạy đó.
  2. Đặt biến kho FLASHDATA_BIN và FLASHDATA_STATE_DIR đến đường đi tuyệt đối của nó, và FLASHDATA_PROFILE tới tên hồ sơ đã cài đặt.
.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)'

Chạy kiểm tra truy cập

Sau khi tiết kiệm dòng công việc trên chi nhánh mặc định của kho, mở Hành động FlashData Kiểm tra dòng chảy làm việc của vội vàng. Mong đợi true và kiểm tra thành công. Thiếu quyền truy cập hoặc cho phép không thành công công công việc này mà không gửi đi tìm kiếm.

Giữ trạng thái thực hiện qua công việc

Một vận động viên chạy thi bắt đầu mà không có nhật ký ban đầu. Dùng tình trạng ứng dụng bền bỉ hoặc người chạy đua kiên trì để làm việc thường xuyên. Cài đặt lại chỉ khóa không thể nhận diện được việc đã làm trước. Giữ thư mục chính quy và kết xuất tác vụ là riêng; đừng tải lên nó như là tạo tác ci.

Cấu hình các thiết lập cache ở đây

Dừng công văn. Trong thư mục nhiệm vụ, điểm FLASHDATA_KEY_FILE tại chìa khóa thay thế cho cùng tài khoản và các nguồn cần thiết, rồi chạy các lệnh bên dưới. Lặp lại kiểm tra truy cập và deployment-check.sh; kỳ vọng cached: true. Thu hồi phím cũ sau khi thẩm tra, và giữ hồ sơ và thư mục chính quy.

Thay thế các phím thông qua 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

Dừng truy cập hoàn toàn

Tạm dừng chương trình, hủy bỏ kết nối phím hay tác nhân trong bảng điều khiển, rồi lặp lại kiểm tra truy cập miễn phí. Nó phải thất bại. Bản ghi địa phương riêng không thu hồi chứng nhận máy phục vụ; đã xuất tập tin còn lại trên đĩa.

Kiểm tra lại thất bại

Triệu chứngSửa
Không tìm thấy lệnh / sai CLI phiên bảnKiểm tra lệnh -v flashdata và FLASHDATA_BIN in runtime.sh. Vì Docker, xây dựng lại và chạy ảnh --version Kiểm tra.
Bị mất núi hoặc bị từ chốiTạo thư mục và tác vụ trên đó Docker chủ sở hữu của dịch vụ UID/GID. Giữ đường đi ổn định.
replacement_requires_flagHồ sơ có một phím đã lưu khác. Kiểm tra truy cập đã có trước; sử dụng tiến trình quay cho một thay thế đã định.
Không thể giải mã truy cập lưuHãy chạy như người dùng đã cung cấp cho nó, trong cùng một môi trường thị trường thị trường-đồ thị. Truy cập vào một điểm đến mới thay vì sao chép một hồ sơ máy tính xách tay đã mã hóa.
Chi phí kiểm tra trả về falseKiểm tra balance.json và preflight.json. Cần phải có giá cả sẵn có, sự cho phép nguồn lực và sự số dư đủ trước khi nộp đơn.
run_account_mismatchKiểm tra tài khoản đã chọn và nguồn của API. Phục hồi truy cập gốc; không thay đổi tên của chạy để phục hồi lại.
run_id_input_conflictPhục hồi yêu cầu ban đầu từ lần thử request.json. Dùng một lần chạy mới ID Chỉ cho một nhiệm vụ được trả lương mới.
Xoá tìm kiếmKiểm tra xem tên chạy trốn có trực tuyến và có mọi nhãn ghi nhận. Dòng chảy công việc này đòi hỏi sự kiên trì tự chủ. Linux Chạy đi.