انتقل إلى المحتوى

توثيق واجهة Fileverity API

البدء السريع

أنشئ مساحة عمل ومفتاح API ونفّذ أول فحص لنص وأول فحص لصورة باستخدام cURL أو JavaScript fetch أو Python requests.

عرض بصيغة Markdownآخر تحديث: 2026-11-04

تنقلك هذه الصفحة من التسجيل إلى أول نتائجك. تحتاج إلى حساب في Fileverity وإلى طرفية فيها curl وjq، وإلى ملف JPEG أو PNG أو WebP لمثال الصورة.

1. افتح لوحة التحكم

سجّل الدخول عبر fileverity.com/console برمز يصلك بالبريد الإلكتروني أو عبر Google. ينشئ أول تسجيل دخول لك مساحة عمل شخصية برصيدها المدفوع مسبقًا.

تبدأ مساحة عملك الأولى بعدد 5 من فحوصات الصور أو المستندات المجانية، إضافةً إلى 5,000 حرف نصي مجاني. لا حاجة إلى بطاقة. رصيد بدء مجاني واحد لكل شخص، وعدد محدود لكل نطاق بريد إلكتروني لشركة. على زملاء الفريق الانضمام عبر دعوة. يُستخدم رصيد البدء المجاني قبل رصيدك. راجع الأسعار والفوترة.

2. أنشئ مفتاح API

افتح مفاتيح API واختر أنشئ مفتاحًا وسمِّه واختر وضعه. أنشئ مفتاحًا من نوع اختبار أولًا: يعيد نتائج نموذجية ثابتة، ولا يستدعي أي نموذج، ولا يُحتسب عليه أي رسم أبدًا. يظهر المفتاح كاملًا مرة واحدة فقط، فانسخه الآن.

أبقِ المفتاح خارج نظام التحكم في الإصدارات وخارج شيفرة المتصفح. صدِّره بوصفه متغير بيئة:

export FILEVERITY_API_KEY=fv_test_...

3. تحقق من مفتاحك

يعمل GET /models مع أي مفتاح صالح ولا يُحتسب عليه أي رسم أبدًا. إذا أعادت الاستجابة 200 مع قائمة النماذج فالمفتاح سليم. وإذا أعادت 401 فالمفتاح مفقود أو مكتوب خطأً أو مُبطَل.

curl -i https://api.fileverity.com/v1/models \  -H "Authorization: Bearer $FILEVERITY_API_KEY"

4. افحص نصًا

أرسل نصًا عاديًا من 100 كلمة على الأقل إلى POST /text/detections. تقرأ الأمثلة النص من ملف، لذا احفظ أي فقرة من 100 كلمة أو أكثر باسم essay.txt أولًا. يكتب هذا الأمر نصًا تجريبيًا:

cat > essay.txt <<'EOF'Honestly, the delivery was a mess. The driver turned up at six in the evening,the pallet was wet on one side, and nobody at the depot would pick up thephone until Monday. I photographed everything before signing, which is theonly reason we have a leg to stand on. In today's fast-paced logisticslandscape, it is essential for businesses to prioritize reliable deliveryperformance, as timely and undamaged shipments play a pivotal role infostering customer trust and long-term satisfaction. We lost two days. Martarebuilt the schedule by hand and the Leeds order still went out late. Movingforward, it is crucial to implement robust quality assurance measures andestablish clear communication channels, ensuring that all stakeholders remainaligned and that potential issues are proactively addressed. For now I amasking for a credit note and a named contact. Not another apology.EOF
curl https://api.fileverity.com/v1/text/detections \  -H "Authorization: Bearer $FILEVERITY_API_KEY" \  -H "Content-Type: application/json" \  -d "$(jq -Rs '{text: .}' essay.txt)"

مع مفتاح اختبار تكون الاستجابة نتيجة ثابتة لنص كتبه إنسان. أما مع مفتاح حقيقي فتبدو هكذا:

{  "id": "tdet_8Hk2pQ4vN9sL1xR7cW3mY6zB",  "object": "text.detection",  "created": 1793664000,  "model": "fvdoc-3-text-2026-11-03",  "livemode": true,  "language": "en",  "verdict": "mixed",  "score": 0.97,  "ai_fraction": 0.41,  "segments": [    {      "start": 212,      "end": 433,      "score": 0.97    },    {      "start": 579,      "end": 790,      "score": 0.93    }  ],  "usage": {    "characters": 1412,    "free_characters": 0,    "billed_units": 2  }}

التفاصيل، بما فيها طريقة عمل الإزاحات، في كشف النصوص.

5. افحص صورة

تتطلب الصور والمستندات استدعاءين: ارفع الملف، ثم أنشئ تحليلًا يشير إليه. التحليل هو فحص صورة أو مستند واحد. يُبقي Prefer: wait=60 الطلب معلّقًا حتى تجهز النتيجة، لمدة تصل إلى 60 ثانية.

FILE_ID=$(curl -s https://api.fileverity.com/v1/files \  -H "Authorization: Bearer $FILEVERITY_API_KEY" \  -F file=@photo.jpg | jq -r .id) curl https://api.fileverity.com/v1/analyses \  -H "Authorization: Bearer $FILEVERITY_API_KEY" \  -H "Content-Type: application/json" \  -H "Prefer: wait=60" \  -d "{\"model\": \"fvimg-2\", \"file\": \"$FILE_ID\"}"

يعيد التحليل المنتهي 200 مع status: succeeded وملخص موجز summary وتقرير كامل result.report. وإذا انتهت مدة الانتظار أولًا، تحصل على 202 مع status: processing؛ اجلب النتيجة لاحقًا عبر GET /analyses/{id} أو استقبل Webhook. راجع التحليلات.

{  "id": "an_8Hk2pQ4vN9sL1xR7cW3mY6zB",  "object": "analysis",  "created": 1793700120,  "model": "fvimg-2-2026-10-30",  "livemode": true,  "status": "succeeded",  "file": {    "name": "claim-photo.jpg",    "bytes": 2481920,    "format": "jpeg"  },  "report_id": "FV-7K2M-9QXD-4T8R",  "report_url": "https://fileverity.com/verify/FV-7K2M-9QXD-4T8R",  "summary": {    "level": "L2",    "assessment": "authentic_untouched",    "action": "accept",    "ai": "very_low",    "edit": "none"  },  "result": {    "report": {      "schema": "fileverity.report/1",      "id": "FV-7K2M-9QXD-4T8R"    },    "stamped_at": 1793700130  },  "error": null,  "progress": null,  "usage": {    "amount": 199,    "currency": "usd",    "funding": "balance"  },  "metadata": {    "order_id": "A-10492"  },  "completed_at": 1793700131,  "expires_at": 1794304931}

مع مفتاح اختبار يُتحقق من صحة الملف دون تخزينه، ويعيد التحليل فورًا نموذجًا ثابتًا. ويبدأ رقم تقريره بالبادئة FV-TEST- وليس له صفحة تحقق عامة.

6. الانتقال إلى الإنتاج

  • أنشئ مفتاحًا من نوع حقيقي في لوحة التحكم واستخدمه بدلًا من مفتاح الاختبار. تعمل الشيفرة نفسها دون تغيير.
  • استخدم رصيد البدء المجاني، أو أضف رصيدًا إلى مساحة عملك من الرصيد. الحد الأدنى لإضافة الرصيد هو ⁦US$ 19⁩.
  • حدّد حدًّا شهريًا للإنفاق على المفتاح، وأضف نقطة نهاية Webhook بدلًا من الاستعلام المتكرر.
  • أرسل Idempotency-Key في طلبات POST حتى لا تؤدي إعادة المحاولة إلى تنفيذ الفحص مرتين. راجع Idempotency.

لمعرفة ما يفحصه كل فحص وأين تستخدمه الفرق، راجع واجهة API لكشف الصور المولَّدة بالذكاء الاصطناعي وواجهة API لكشف تزوير المستندات.

التالي: يضم أمثلة برمجية برامج كاملة بلغتي Node.js وPython لكل فحص وللتعامل مع Webhooks. ثم اقرأ المصادقة والمفاتيح والأخطاء ومرجع API. إذا لم يعمل شيء، راسل hello@fileverity.com أو استخدم صفحة التواصل، واذكر معرّف الطلب من ترويسة x-request-id.