ابنِ على YAHYI — بمفاتيح آمنة وحدود واضحة

منصة المطورين تتيح لك إنشاء وكلاء، وربط متجرك، واستدعاء YAHYI من أنظمتك عبر API v1 — بمشاريع، ومفاتيح مجزأة تظهر مرة واحدة، ونطاقات، وحد معدل، وسجل طلبات كامل. لا حزمة SDK منشورة بعد؛ الويدجت ملف JavaScript قابل للتضمين مباشرة.

ما هو مبني فعلاً؟

تدفق التكامل

1. أنشئ حساباً ومساحة عمل، ثم مشروع مطور من لوحة المطورين.
2. أنشئ مفتاحاً بالنطاقات المطلوبة فقط، وانسخه فوراً — لن يظهر مجدداً.
3. أرسل المفتاح في ترويسة Authorization: Bearer أو X-Api-Key.
4. استدعِ /api/v1/agents أو /api/v1/conversations؛ الأخطاء تأتي بصيغة موحدة مع معرّف تتبع.
5. راقب الطلبات من سجل لوحة المطورين، ودوّر المفتاح أو ألغه عند أي شك.

مثال — طلب واستجابة (مفتاح وهمي للتوضيح فقط)

curl https://www.yahyi.com/api/v1/agents \
  -H "Authorization: Bearer yahyi_test_EXAMPLE_KEY_DO_NOT_USE" \
  -H "Accept: application/json"

{
  "data": [
    { "id": 1, "name": "Store Agent", "type": "store",
      "status": "active", "channel": "widget" }
  ]
}

{
  "error": { "code": "unauthorized",
             "message": "Invalid or revoked API key.",
             "trace_id": "00000000-0000-0000-0000-000000000000" }
}

ملاحظات أمان

• المفاتيح لا تنتهي تلقائياً إلا إذا حددت تاريخ انتهاء عند الإنشاء؛ يُنصح بالتدوير الدوري.
• معرّفات من مساحات عمل أخرى تُعيد 404 عبر API — لا تسريب عبر تخمين المعرفات.
• تكاملات API الخارجية: HTTPS فقط، بلا إعادة توجيه، بلا عناوين خاصة أو ترميزات رقمية للعناوين، مع فحص DNS عند الإمكان — وDNS rebinding يبقى قيداً يتطلب وكيل خروج في الإنتاج.
• سجلات الطلبات لا تحتوي مفاتيح أو وسائط حساسة (تُحذف قبل التسجيل).

أسئلة شائعة