تصفح الوثائق
البدء
استخدم المضيف وبيانات الاعتماد الصحيحين، ثم تحقّق من الوصول بطلب مجاني واحد.
في هذه الصفحة
قاعدة URLs
| الغرض | قاعدة URL | المصادقة |
|---|---|---|
| الاستفسارات عن البيانات والوظائف | https://data.flashdata.dev/v1 | X-API-Key |
| الهوية، والتوازن، والتسعير، والحدود، والاستخدام | https://api.flashdata.dev/v2 | X-API-Key |
| Remote MCP | https://data.flashdata.dev/mcp | OAuth أو X-API-Key |
مرشدو التوثيق
وتستخدم طلبات شركة REST X-API-Key مع مُحاكمة أو مفتاح مالك. إرسال أجهزة JSON مع Content-Type: application/json. CLI profiles, SDK environments and MCP connections store accreditation separately.
X-API-Key: fd_YOUR_API_KEY
Content-Type: application/jsonدعوا MCP المضيف يحصل على هذا المكسور من خلال الشعار استخدمه فقط في MCP نقطة النهاية. ويستخدم المضيفون مفتاح API بدلا من ذلك يرسلون X-API-Key.
Authorization: Bearer YOUR_MCP_ACCESS_TOKENتحقق من مفتاحك
أديري هذا في محطتك نقطة نهاية الهوية تدقق في الدخول دون أن تُصرف الائتمانات. اضغط على المفتاح إذا FLASHDATA_API_KEY تم تحديده بالفعل.
Requires Bash and cURL 7.76+. تزلج على المفتاح المخفي إذا كانت البيئة الخاصة بك بالفعل إمدادات FLASHDATA_API_KEY. أديروا أوامر القراءة في نفس المحطة
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY(
: "${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}"
curl --fail-with-body --silent --show-error --max-time 20 \
--header "X-API-Key: $FLASHDATA_API_KEY" \
'https://api.flashdata.dev/v2/api-access/identity' || exit
printf '\n'
)قفزة المفتاح المخفي إذا FLASHDATA_API_KEY تم تحديده بالفعل. أديروا أوامر القراءة في نفس المحطة
# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKey& {
$ErrorActionPreference = 'Stop'
if ([string]::IsNullOrWhiteSpace($env:FLASHDATA_API_KEY)) {
throw 'Set FLASHDATA_API_KEY first'
}
$flashdataHeaders = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY }
$flashdataBase = 'https://api.flashdata.dev/v2'
$flashdataUri = "$flashdataBase/api-access/identity"
Invoke-RestMethod -Uri $flashdataUri `
-Headers $flashdataHeaders -TimeoutSec 20 -MaximumRedirection 0 |
ConvertTo-Json -Depth 20
}الاستجابة المتوقعة
يتوقع HTTP 200. تحقق من الحساب المقصود access: ready ومصدرك في نطاقات وهناك مفتاح مؤقت يحتوي على accountType: temporary؛ ويستلزم العمل المتجدد للمالكين أن يعاد تشغيله recurringAllowed: true.
{
"accountId": "acc_example",
"apiKeyId": "key_example",
"accountType": "owned",
"access": "ready",
"scopes": [
"google_search"
],
"recurringAllowed": true
}مخزن موقع URLs
وتشتمل النتيجة والشحنة URLs على إذن خاص بها. إتبعوا المُعادون URL بدون X-API-Key, OAuth كُن أو بسكويت مُصفّح.
التوثيق المسبب للمشاكل
| استجابة | الخطوة التالية |
|---|---|
| 401 | تحقق من المفتاح في هذه البيئة، وقضيته وإلغاءه. استخدمي مفتاحاً حالياً من طراز API، وليس من طراز MCP أو من طراز Bearer prefix. |
| 403/ source missing | أطلب من المالك أن يمنح المصدر المطلوب لهذا المفتاح |
| 503 على هذا القراء الحر | أعد القراءة لاحقاً ولم يتم التحقق من وضع الحساب؛ ولا تستنتج أن هناك استفساراً مدفوعاً جاهزاً. |