تصفح الوثائق
البدء
اصنع مفتاحاً لتطبيقك أو عميلك تخزينه، والتحقق من الوصول وإدارة دورة حياته.
في هذه الصفحة
1. إنشاء مفتاح
- وقّع على حسابك المُحقّق وفتح API Keys. اعيد استخدام المفتاح المرخص به اذا كان لديك واحد بالفعل
- سمّه للتطبيق والبيئة، واختيار الإنهاء واختيار المصادر التي يحتاجها. مختارة Google Search لمثال البحث الأول.
- اصنع المفتاح واحتفظ به تحته أعطوا عملاء مستقلين و تطبيقات الإنتاج مفاتيح منفصلة حتى تتمكن من إبطالها بشكل فردي
2. تخزين المفتاح
اختر طريقة تشغيل FlashData. تقرأ أمثلة API وSDK المتغير FLASHDATA_API_KEY؛ ويمكن لـ CLI حفظ المفتاح في ملفه الشخصي المحمي. في الإنتاج، مرّر بيانات الاعتماد من مخزن الأسرار لديك.
# 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# 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الصق المفتاح عند مطالبة الإدخال المخفي. لملف شخصي مُسمّى، أضف --profile NAME هنا وفي الأوامر اللاحقة. يتطلب استبدال مفتاح ملف شخصي مُعدّ مسبقًا استخدام login --replace.
flashdata auth login3. التحقق من إمكانية الوصول
تشغيل الشيك مجانا في نفس المحطة أو CLI لمحة عامة إستخدمي هذا المقاس الذي يطابق كيف خزنتي المفتاح
أعد استخدام 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 من الفحص السابق في الطرفية نفسها.
& {
$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
}إستعملْ وصولَكَ المنقذَ CLI. من أجل ملف مسمّى، ملحق --profile نيم إلى كل أمر هذه القراءات لا تنفق اياً من الأستفكار
flashdata auth statusتأكيد الحساب والمصدر
يعيد HTTP هذه الحقول مباشرة. في CLI JSON، تجدها ضمن data.identity.identity، ويجب أيضًا أن تكون data.accessVerified: true.
| تحقق | المتوقع |
|---|---|
| accountId | الحساب الذي يملك عبء العمل هذا. |
| access | ready |
| scopes | تشمل google_search للبحث الأول. |
| recurringAllowed | true قبل عمل المالك المقرر. |
كيف تعمل إذن المصدر
المفتاح لا يمكن أن يستخدم إلا مصادره الممنوحة. واختيار المنتجات منفصل عن التسعير: فكل مفتاح في الحساب ينفق من الرصيد المشترك، بما في ذلك الائتمانات المشتراة. المفتاح المقيد لا يملك قبعة إنفاق خاصة به وتقتضي المنتجات المقبلة منح إذن صريح.
إذا تم كشف المفتاح
- قم بفحص المفتاح المكشوف فوراً في الصفحة المتطابقة أدناه، ووقف متصليه المقررين.
- اصنع بديلاً مع الأذن المطلوبة، وتركيبه في مخزن كل متصل سري، وتحقق حراً فوق.
- Review History and account usage for expected activity. نقل سر من ملف لا يلغيه
تناوب المفتاح
- إنشاء بديل بالمصادر المطلوبة وتركيبه في البيئة المستهدفة.
- كرر التحقق الحر أعلاه، ثم تغيير الطلب أو الجدول الزمني. تحديث كل متصل مقصود
- قم بفحص المفتاح القديم بعد تبديل المُتصلين السر الذي يتم تحديثه على حاسوبك المحمول لا يستكمل الخدمات المنشورة
flashdata auth login --replace
flashdata auth statusRevoke access
أوقفوا المُتصلين المُحددين، و ألغيوا المفتاح المُطابق أو الرابط أدناه، ثم أُعيدوا التحقق الحرّ مع الخلود القديم. وينبغي رفضه. لا يلغي التعبئة المحلية وصول الخادم
| نوع الوصول | إلى أين ألغي |
|---|---|
| مفتاح طراز API | API Keys |
| وكيل مدعَّى به | Settings → Connected apps → Agent connections |
| MCP OAuth | Settings → Connected apps |