مفاتيح واجهة برمجة تطبيقات المطورين

ما هي واجهة برمجة التطبيقات الخاصة بالمطورين؟

يُتيح تطبيق LeyApp واجهة برمجة تطبيقات REST عامة على المسار /api/v1، تُمكّنك من البحث عن المحامين، والاطلاع على مدى توفرهم، وبدء الحجوزات من موقعك الإلكتروني، أو تطبيقك، أو أداتك الداخلية. يُمكنك الوصول للقراءة فقط دون الحاجة إلى بيانات اعتماد، ولكن مفتاح API يُتيح لك الوصول إلى عدد أكبر من الصلاحيات، ويفتح نقاط نهاية إضافية، ويُوفر لك لوحة تحكم تعرض مفاتيحك وبيانات استخدامك.

يمكن لأي حساب في LeyApp إنشاء مفاتيح API، فلا حاجة لنوع حساب خاص. لا يتم تحصيل رسوم الحجوزات التي تتم عبر واجهة برمجة التطبيقات تلقائيًا، حيث يقوم العميل دائمًا بالتأكيد والدفع على موقع leyapp.es، وبالتالي لا يتعامل نظامك مع الأموال أو تفاصيل البطاقات.

إنشاء مفتاح API

تتم إدارة المفاتيح من لوحة التحكم الخاصة بك:

1. افتح لوحة التحكم → المطور من الشريط الجانبي.
2. انقر فوق "إنشاء مفتاح" وقم بإعطائه اسمًا وصفيًا، على سبيل المثال "أداة موقع الويب (الإنتاج)".
3. اختر نوع المفتاح: مباشر للطلبات الحقيقية، أو اختبار للتجربة بأمان.
4. انسخ المفتاح فوراً واحفظه في مكان آمن، مثل مدير كلمات المرور أو التخزين السري لمزود خدمة الاستضافة الخاص بك.

مفاتيح الاختبار مقابل المفاتيح الفعلية

تتصرف مفاتيح الاختبار (leyk_test_...) تمامًا مثل المفاتيح الفعلية - نفس نقاط النهاية، ونفس الاستجابات، ونفس التحقق - مع اختلاف جوهري واحد: لا يحدث أي شيء فعلي. يتم التحقق من طلب الحجز التجريبي بالكامل مقابل التوافر الفعلي، ولكن لا يتم إنشاء أي نية حجز ولا يتم إخطار أي محامٍ.

تُنشئ المفاتيح المباشرة (leyk_...) نوايا حجز حقيقية. عندما يتبع العميل رابط التأكيد الخاص بنية الحجز المباشرة، يتم نقله إلى الصفحة العادية.LeyApp عملية الدفع والتأكيد.

مفاتيح مكتب المحاماة

إذا كنت تعمل في مكتب محاماة على منصة LeyApp، فستجد في لوحة التحكم ← قسم المطورين قائمتين منفصلتين: مفاتيحك الشخصية ومفاتيح مكتبك. مفتاح المكتب ملكٌ للمكتب، وليس للشخص الذي أنشأه، لذا يبقى فعالاً حتى عند تغيير هذا الشخص لمنصبه أو مغادرته.

يستطيع المالكون والمسؤولون إدارة مفاتيح الشركة مباشرةً. أما باقي الأعضاء، فيبدأون بدون أي صلاحيات وصول، ويجب منحهم الصلاحيات تدريجياً من قائمة أعضاء الشركة.

• عرض - اطلع على مفاتيح الشركة، وبادئاتها، وتاريخ آخر استخدام لكل منها. ولا يُكشف السر نفسه لأي شخص مرة أخرى، بما في ذلك المالكين.
• إدارة - إنشاء مفاتيح الشركة وإلغاؤها وتعليقها وتقييدها.
• Webhooks — إدارة نقاط نهاية Webhooks الخاصة بالشركة.

تُطبَّق ضوابط إضافية على المفاتيح الثابتة. يمكنك تقييد المفتاح بقائمة من عناوين IP أو نطاقات عناوين، بحيث يُرفض حتى المفتاح المُسرَّب من أي مكان آخر. كما يمكنك تعليق المفتاح مؤقتًا دون حذفه، وهو أمر مفيد أثناء التحقيق في أمر غريب.

باستخدام مفتاحك

أرسل المفتاح في ترويسة Authorization لكل طلب: "Authorization: Bearer leyk_...". لا تزال الطلبات التي لا تحتوي على مفتاح تعمل مع نقاط النهاية العامة، ولكن بمعدلات طلبات مجهولة أقل.

تتضمن كل استجابة ترويسة X-Request-Id. إذا حدث أي خلل غير متوقع، يُرجى تضمين هذا المعرّف عند التواصل مع الدعم الفني، فهذا يُتيح لنا تحديد طلبك بدقة في ثوانٍ.

حدود المعدل

تبدأ المفاتيح الجديدة من المستوى المجاني: 60 طلبًا في الدقيقة و5000 طلبًا في اليوم. يوضح لك كل ردّ مدى تقدمك عبر ترويسة X-RateLimit-Limit وX-RateLimit-Remaining؛ إذا تجاوزت الحد، ستتلقى ردًا برمز 429 مع ترويسة Retry-After تُخبرك بموعد المحاولة مرة أخرى.

توجد مستويات أعلى للشركاء ويتم منحها من قبل فريق LeyApp - تواصل معنا عبر نموذج الدعم إذا كانت عملية التكامل الخاصة بك تحتاج إلى مساحة أكبر.

حفظ المفاتيح في مكان آمن

مفتاح واجهة برمجة التطبيقات (API) هو بمثابة كلمة مرور لتكاملك. تعامل معه على هذا الأساس:

• لا تضع مفتاحًا في كود جانب العميل أو تطبيقات الهاتف المحمول أو المستودعات العامة - أي شخص يمكنه قراءته يمكنه إنفاق حد المعدل الخاص بك والتصرف ضمن نطاقات المفتاح.
• استخدم مفتاحًا منفصلاً لكل عملية تكامل أو بيئة، حتى تتمكن من إلغاء واحد دون تعطيل الآخرين.
• قم بإلغاء المفاتيح التي لم تعد تستخدمها. الإلغاء فوري - الطلبات التي تستخدم مفتاحًا ملغيًا تفشل في المكالمة التالية.
• إذا كان هناك احتمال لتسريب مفتاح، فقم بإلغائه فورًا من لوحة التحكم ← المطور، ثم أنشئ مفتاحًا بديلًا. عملية التناوب لا تتطلب أي توقف: أنشئ المفتاح الجديد أولًا، ثم انشره، ثم ألغِ المفتاح القديم.

استكشاف الأخطاء

أحصل على رمز الخطأ 401 "غير صالح"API مفتاح".

تأكد من أن عنوان الرسالة هو بالضبط "Authorization: Bearer leyk_..." بدون أي مسافات زائدة، وأن المفتاح لم يتم إبطاله. لاحظ أن رموز MCP (ley_...) من الإعدادات ← رموز API هي بيانات اعتماد مختلفة وغير صالحة على واجهة برمجة تطبيقات REST.

أحصل على رسالة الخطأ 429 "تم تجاوز الحد الأقصى للسعر".

لقد تجاوزت الحد المسموح به للدقيقة أو اليوم في باقتك. التزم برسالة "إعادة المحاولة بعد" وأعد المحاولة مع تأخير متزايد. إذا تجاوزت الحد اليومي بانتظام، فاسألنا عن إمكانية الترقية إلى باقة أعلى.

لا تظهر حجوزاتي التجريبية في أي مكان.

هذا مقصود - مفاتيح الاختبار تتحقق من كل شيء ولكنها لا تُنشئ أي شيء. انتقل إلى مفتاح حقيقي لإنشاء نوايا حجز حقيقية.

لا أستطيع رفع تعليق أحد مفاتيح شركتي.

يمكن تعليق المفتاح من قِبل شركتك أو من قِبل LeyApp. ويمكن لأي مالك أو مسؤول رفع التعليق الذي فرضته شركتك. أما التعليق الذي فرضته LeyApp - على سبيل المثال أثناء التحقيق في حركة مرور غير معتادة - فلا يمكن رفعه إلا من قِبلنا، لذا يُرجى التواصل مع support@leyapp.es.