كل الأدلة
المطوّرين5 دقايق قراءة

الواجهة البرمجية — أول طلب في خمس دقايق

اربط متجرك أو نظامك الداخلي بالمنصّة. مفتاح، رأس واحد، وطلب HTTP عادي.

اطلع مفتاح

من الإعدادات ← مفاتيح API. المفتاح بيظهر **مرة واحدة بس** وقت الإنشاء — إحنا بنخزّن بصمته مش المفتاح نفسه، فمش هنقدر نوريهولك تاني.

المفتاح بيدّي وصول لبيانات مساحتك كلها. حطّه في متغيّر بيئة، ماتحطّهوش في كود بيروح للمتصفّح ولا في مستودع عام.

المصادقة

كل طلب بيحمل المفتاح في رأس `Authorization` بصيغة `Bearer`. مفيش جلسات ومفيش كوكيز.

شكل الاستجابة

ثابت عبر كل المسارات، عشان تكتب معالج أخطاء واحد وخلاص:

نجاح
`{ "data": ... }` مع كود 200.
فشل
`{ "error": { "code": "...", "message": "..." } }` مع كود HTTP مناسب.
الأكواد
`unauthorized`، `forbidden`، `rate_limited`، `bad_request`، `not_found`، `internal`.

حدود المعدّل

120 طلب في الدقيقة لكل مفتاح. لو تجاوزت، بتاخد 429 مع رأس `Retry-After` بعدد الثواني اللي تستناها.

احترم الرأس ده بدل ما تعمل إعادة محاولة فورية — الإعادة الفورية بتخلّي المشكلة أسوأ.

أنماط شائعة

  • متجر إلكتروني: كل طلب جديد → أنشئ/حدّث جهة اتصال بالوسوم المناسبة.
  • نظام مواعيد: قبل الموعد بيوم → ابعت قالب Utility بالتذكير.
  • CRM خارجي: زامن الصفقات في الاتجاهين.

التوثيق الكامل

قايمة المسارات والحقول كاملة موجودة في توثيق المنتج. لو محتاج مسار مش موجود، كلّمنا — أغلب الإضافات بتيجي من طلبات زي دي.