العناصر المخصصة: API
واجهة API هي نموذج قيمه المملوءة Skava كـ JSON إلى عنوان تحدده (النظام الخلفي الخاص بك). بهذه الطريقة يمكنك توصيل Skava بأمان مع الأنظمة الخاصة بك.
تدير واجهات API في Webapp تحت العناصر المخصصة → قلب واجهات API. الإنشاء والتحرير مقيد على مسؤولي الشركة؛ يمكن لجميع أعضاء الشركة بعد ذلك تشغيل الواجهات المفرج عنها.
إعداد واجهة API
تتكون الواجهة من حقول الإدخال (تشكل JSON) والعنوان الهدف والمصادقة.
- أنشئ الحقول: كل حقل يحصل على مفتاح JSON. على اليمين ترى معاينة JSON الحية التي يتم إرسالها إلى النظام الخلفي بالضبط بهذه الطريقة.
- العنوان (URL): عنوان
https://لنظامك الخلفي. فقط HTTPS وعناوين يمكن الوصول إليها علنياً مسموحة (انظر الأمان أدناه). - الطريقة:
POST(افتراضي) أوPUTأوPATCHأوGET. معGETيتم إلحاق القيم كمعاملات استعلام بدلاً من إرسالها في الجسم. - المصادقة: عيّن اسم الرأس (مثل
التفويض) وقيمة البادئة (مثلBearer) ثم احفظ الرمز. اختياري عيّن تاريخ انتهاء الصلاحية. - حقول الاستجابة (اختيارية): حدد حسب المسار القيم من استجابة النظام الخلفي التي يجب عرضها — مثل
order.idأوitems[0].sku. - تحقق مع Ping و طلب الاختبار ثم الإفراج.
خزن الرمز بأمان
الرمز يُخزن مشفر ولا يُرجع أبداً إلى العملاء — التطبيق يعرض فقط ما إذا تم تعيين رمز وعند انتهاء الصلاحية. عند الإرسال Skava يلحقه من جانب الخادم برأس مكون. إذا عيّنت تاريخ انتهاء الصلاحية فـ Skava يرفض الاتصال بعد انتهاء الصلاحية ويطلب تجديد الرمز.
الاختبار: Ping وطلب الاختبار
- Ping — فحص وصول خفيف. يتحقق فقط ما إذا يستجيب عنوانك ولا يرسل رمز أو بيانات النموذج في العملية. يعرض الوصول والحالة ووقت الاستجابة. مثالي كخطوة أولى.
- طلب الاختبار — التجربة الحقيقية: يرسل بيانات عينة بما في ذلك الرمز إلى عنوانك ويعرض لك الاستجابة الكاملة وكذلك حقول الاستجابة المستخرجة.
كمسؤول يمكنك تشغيل كليهما بينما لا تزال في وضع المسودة للتحقق من التكامل قبل الإفراج.
المسودة والإفراج
كل واجهة تبدأ كـ مسودة ويمكن تحريرها بحرية. عندما يكون كل شيء جاهزاً تفرج عنه مع الإفراج.
الواجهات المفرج عنها غير قابلة للتغيير. هذا مقصود: بحيث بعد الإفراج لا يمكن لأحد سراً تبديل العنوان الهدف أو الرمز. إذا كنت تريد تغيير شيء ما أنشئ إصدار جديد.
الأمان
لمنع سوء استخدام الواجهة تُطبق قوانين صارمة: فقط عناوين HTTPS مسموحة والعنوان يجب أن يشير إلى عنوان هدف عام — العناوين الداخلية (مثل localhost أو الشبكات الخاصة أو البيانات الوصفية السحابية) مرفوضة. يفحص Skava هذا على كل استدعاء ويتصل بالضبط بالعنوان المحقق منه لا يتبع أي عمليات إعادة توجيه ويحد من المهلة الزمنية وحجم الاستجابة.
المتعلقة
هل تريد بدلاً من ذلك بناء قالب مستند قابل للملء؟ انظر العناصر المخصصة: المستندات.
الأسئلة الشائعة
ما هي واجهة API في Skava؟
نموذج قيمه المملوءة Skava كـ JSON إلى عنوان تحدده (النظام الخلفي الخاص بك) — مفيد لتوصيل Skava مع أنظمتك الخاصة.
من يُسمح له بإنشاء وتشغيل واجهات API؟
الإنشاء والتحرير مقيد على مسؤولي الشركة. يمكن لجميع أعضاء الشركة بعد ذلك تشغيل واجهة مفرج عنها.
ما الفرق بين "Ping" و "طلب الاختبار"؟
Ping يتحقق فقط ما إذا كان العنوان قابلاً للوصول — بدون رمز وبدون بيانات. طلب الاختبار يرسل بيانات عينة بما في ذلك الرمز ويعرض الاستجابة الكاملة.
هل رمز API الخاص بي آمن؟
نعم. الرمز يُخزن مشفر ولا يُسلم أبداً للعملاء. يعرض التطبيق فقط ما إذا تم تعيين رمز وعند انتهاء الصلاحية.
أي العناوين مسموحة كنقاط نهاية؟
فقط عناوين https:// يمكن الوصول إليها علنياً. الأهداف الداخلية مثل localhost أو الشبكات الخاصة أو البيانات الوصفية السحابية مرفوضة — هذا يحمي ضد سوء استخدام الواجهة.
لماذا لا يمكنني تغيير واجهة مفرج عنها بعد الآن؟
الواجهات المفرج عنها غير قابلة للتغيير بقصد — بحيث بعد الإفراج لا يمكن لأحد تبديل العنوان الهدف أو الرمز. للتغييرات أنشئ إصدار جديد.