/v1،
مجمّعة حسب المورد، مع إعداد المصادقة مسبقًا.
التنزيل
ستطالبك روابط التنزيل بتسجيل الدخول باستخدام حسابك في Living Security
قبل تقديم الملف.
مجموعة Living Security API v1
مجموعة Postman Collection v2.1 تتضمن جميع عمليات
/v1 مع إعداد مصادقة Basic
مسبقًا. قيمة baseUrl في المجموعة فارغة — حدد بيئة إقليمية
قبل إرسال أي طلب.تنزيل المجموعةبيئة الإنتاج (الولايات المتحدة)
baseUrl مضبوطة مسبقًا على https://api.us-east-1.livingsecurity.ai/v1، مع
متغيرَي apiKeySecret وcontractVersion الفارغين لتقوم بتعبئتهما.تنزيل بيئة الإنتاج للولايات المتحدةبيئة الإنتاج (الاتحاد الأوروبي)
baseUrl مضبوطة مسبقًا على https://api.eu-west-1.livingsecurity.ai/v1، مع
متغيرَي apiKeySecret وcontractVersion الفارغين لتقوم بتعبئتهما.تنزيل بيئة الإنتاج للاتحاد الأوروبيقالب البيئة
المتغيرات نفسها مع
baseUrl فارغ، لإعدادات غير الإنتاج.تنزيل قالب البيئةالإعداد في Postman
1
استيراد الملفات
في Postman، اختر استيراد ثم أسقط ملف المجموعة مع بيئة
الإنتاج (الولايات المتحدة) أو الإنتاج (الاتحاد الأوروبي) التي تطابق
المنظمة. راجع المناطق.
2
إنشاء مفتاح API
في لوحة التحكم، افتح الإعدادات ← التكاملات والمطورون ←
Developer Hub، ثم أنشئ حساب خدمة وأنشئ مفتاح API. يبدأ سر المفتاح بـ
lsk_live_ ويُعرض
مرة واحدة فقط — انسخه فورًا. راجع
مفاتيح API للتفاصيل.3
لصق السر
عيّن المتغير
apiKeySecret — إما في البيئة المستوردة
(موصى به؛ فهو متغير من نوع سري) أو في علامة التبويب
المتغيرات الخاصة بالمجموعة.4
إرسال طلب
حدد البيئة الإقليمية المستوردة، وافتح أي طلب — على سبيل المثال
المنظمة ← Retrieve the organization — ثم انقر إرسال. لا
ترسل أي طلب قبل تحديد بيئة؛ فقيمة
baseUrl في المجموعة فارغة
عن قصد.كيفية إعداد المصادقة مسبقًا
تضبط المجموعة مصادقة Basic على مستوى المجموعة باسم المستخدمapikey
وكلمة المرور {{apiKeySecret}}. تقبل واجهة API سر المفتاح في أي من حقلي
مصادقة Basic، لذلك يعمل هذا الإعداد كما هو بمجرد تعيين المتغير.
إذا كنت تفضّل مصادقة Bearer، فغيّر نوع Authorization في المجموعة
إلى Bearer Token واستخدم {{apiKeySecret}} كرمز — إذ تقبل واجهة API
السر نفسه بالطريقتين.
لا يتطلب استخدام ترويسة Bearer مع مفتاح API استخدام OAuth. لاستخدام OAuth،
عيّن Bearer Token إلى رمز وصول OAuth الخاص بك بدلًا من سر مفتاح API.
راجع المصادقة لاختيار الطريقة، و
بيانات اعتماد عميل OAuth لإعداد الرمز والعميل.
ترويسة إصدار العقد
يحمل كل طلب ترويسةLiving-Security-Version مضبوطة مسبقًا على
{{contractVersion}}، وهي معطّلة افتراضيًا. اتركها معطّلة لاستخدام إصدار العقد
المثبّت لمنظمتك. وفعّلها لتثبيت الطلب على إصدار منشور
محدد — راجع سجل التغييرات
للاطلاع على الإصدارات المنشورة.
معلمات الاستعلام والأجسام
مرشحات نقاط النهاية التي تعرض قوائم (limit وpage_token والمرشحات الخاصة بكل مورد)
مضمّنة في كل طلب لكنها معطّلة، بحيث ينجح استدعاء كل
نقطة نهاية بعد استيراد جديد. فعّل المرشحات التي تحتاج إليها واملأها — راجع
ترقيم الصفحات لمعرفة كيفية عمل page_token. أما أجسام
الطلبات في عمليات POST فتكون معبأة مسبقًا بقيم نائبة محددة الأنواع.
يُعاد إنشاء المجموعة من مواصفات OpenAPI المنشورة عند كل تغيير في
العقد — نزّل نسخة جديدة بدلًا من تعديل الطلبات التي
تريد إبقاءها محدّثة.