تخطّى إلى المحتوى

مرجع واجهة برمجة التطبيقات

دليل واجهة برمجة التطبيقات العامة لزينها بايو — صفحات البايو، بطاقة العمل، التحليلات، فحص الصحة.

الإصدار: v3 القاعدة: https://bioz.cc استجابة: JSON / HTML

المصادقة

كل النقاط العامة بدون مصادقة. النقاط الخاصة تتطلب جلسة من زيّنها هب عبر cookies تُضبط تلقائياً بعد تسجيل الدخول في auth.zayenha.com. webhooks تستخدم تواقيع HMAC-SHA256.

النقاط

GET /:slug عام

صفحة بايو عامة (HTML). يخدمها Cloudflare من الذاكرة لأقصى سرعة.

GET https://bioz.cc/your-slug
GET /vcard/:slug.vcf عام

بطاقة عمل رقمية بصيغة RFC 6350 — قابلة للاستيراد في الجوال مباشرة.

GET https://bioz.cc/vcard/your-slug.vcf
POST /api/analytics/view عام

بيكون مجهول لتسجيل مشاهدة/نقرة. محدود المعدّل لكل IP.

POST /api/analytics/view
{"page_id":"…","link_id":"…"}
POST /api/log/error عام

استقبال أخطاء جافاسكربت من الواجهة. محدود إلى 30/دقيقة لكل IP.

POST /api/log/error
{"message":"…","stack":"…","severity":"error"}
GET /health عام

فحص الصحة السطحي — يرجّع 200 إذا كان العامل (Worker) يستجيب.

GET /health → {"ok":true,"app":"bio","version":"3.0.0"}
GET /health/deep عام

فحص عميق يتحقق من D1 و KV و R2 و Hub API. يرجّع 503 إذا فشل أي مكون.

GET /health/deep
GET /sitemap.xml عام

فهرس روابط الموقع لمحركات البحث.

GET /robots.txt عام

سياسة الزحف.

GET /manifest.json عام

PWA manifest — للتثبيت كتطبيق على الجوال.

GET /llms.txt عام

بيان للذكاء الاصطناعي يصف المنصة — مقترح standards.dev/llms-txt.

GET /api/me/wallet يتطلب جلسة

نقاط زيّنها للمستخدم (proxy إلى Hub). يتطلب جلسة Hub.

GET /api/me/notifications يتطلب جلسة

تنبيهات المستخدم.

حدود المعدّل

  • النقاط العامة: 60 طلب/دقيقة لكل IP.
  • مسارات /api/auth/*: 10 طلب/دقيقة.
  • بقشيش (/api/tip): 20/دقيقة.
  • تنزيلات (/api/download): 30/دقيقة.
  • الاشتراك بالنشرة: 10/دقيقة.
  • الذكاء الاصطناعي: حسب الخطة.

تنسيق الخطأ

كل خطأ يأخذ شكلاً موحّداً قابلاً للتحليل آلياً:

{
  "ok": false,
  "error": "Human-readable Arabic",
  "message_en": "Human-readable English",
  "code": "CSRF_REQUIRED",
  "details": { ... }
}

تحتاج مساعدة في التكامل؟

تواصل معنا