دليل تثبيت API
دليل مرجعي
نقطة التغيير 2021

© 2021 Changepoint Canada ULC جميع الحقوق محفوظة. حقوق الحكومة الأمريكية - الاستخدام أو النسخ أو الإفصاح من قبل حكومة الولايات المتحدة يخضع للقيود المنصوص عليها في اتفاقية ترخيص Changepoint Canada ULC وعلى النحو المنصوص عليه في DFARS 227.7202-1 (a) و 227.7202-3 (a) (1995) ، DFARS 252.227-7013 (c) (1) (ii) (أكتوبر 1988) أو FAR 12.212 (a) (1995) أو FAR 52.227-19 أو FAR 52.227-14 (ALT III) ، حسب الاقتضاء. يحتوي هذا المنتج على معلومات سرية وأسرار تجارية لـ Changepoint Canada ULC. الإفصاح محظور بدون إذن كتابي صريح مسبق من Changepoint Canada ULC. يخضع استخدام هذا المنتج لشروط وأحكام اتفاقية الترخيص الخاصة بالمستخدم مع Changepoint Canada ULC. لا يجوز إعادة إنتاج الوثائق إلا من قبل المرخص له للاستخدام الداخلي. لا يجوز تغيير محتوى هذا المستند أو تعديله أو تغييره دون موافقة كتابية صريحة من Changepoint Canada ULC. قد تقوم Changepoint Canada ULC بتغيير المحتوى المحدد هنا في أي وقت ، مع أو بدون إشعار.

تثبيت واجهة برمجة تطبيقات Changepoint

حول تثبيت Changepoint API
يتوفر Changepoint API كواجهة برمجة تطبيقات COM ، وخدمة Windows Communication Foundation (WCF) ، وللتوافق مع الإصدارات السابقة ، Web خدمة تحسينات الخدمات (WSE). للحصول على معلومات حول Changepoint API ، راجع مرجع Changepoint API. للحصول على ملاحظات حول الترقية والتحذيرات والمشكلات المعروفة ، راجع ملاحظات الإصدار في مجلدات الفريق في Changepoint.
ترقية واجهة برمجة تطبيقات Changepoint
إذا كنت تقوم بالترقية من إصدار سابق من Changepoint ، فاستخدم لوحة تحكم Windows لإلغاء تثبيت الإصدار السابق من Changepoint API ومكوناته قبل تثبيت هذا الإصدار.
متطلبات واجهة برمجة تطبيقات Changepoint
يجب عليك تثبيت Changepoint قبل تثبيت Changepoint API. بالنسبة لمتطلبات البرامج ، راجع مصفوفة توافق البرامج Changepoint ، المتوفرة في مجلد فريق ملاحظات الإصدار والتصحيحات لعام 2021 في Changepoint.
File اصطلاحات المسار
في هذا المستند ، يتم استخدام الاصطلاحات التالية للمسارات الشائعة:

• مسار الجذر لتثبيت Changepoint.
  المسار الافتراضي هو:
  ج:البرنامج Files (x86) نقطة التغيير
• موقع الجذر لأدوات Changepoint المساعدة الشائعة ، مثل الأداة المساعدة لإعدادات تسجيل الدخول.
  المسار الافتراضي هو:
  ج:البرنامج Fileق (x86) شائع FilesChangepointChangepoint

تثبيت واجهة برمجة تطبيقات Changepoint

1. من الدليل الجذر لوسائط API Changepoint ، قم بتشغيل setup.exe.
2. اتبع المطالبات حتى تظهر شاشة تحديد الميزات.
3. حدد الميزات التي تريد تثبيتها ، ثم انقر فوق التالي.
4. حدد مجلد وجهة API ، الافتراضي API ، وانقر فوق التالي.
   ملحوظة: يتم تثبيت الأداة المساعدة Changepoint Login Settings في LoginSettings ، بغض النظر عن مجلد الوجهة الذي تحدده.
5. إذا قمت بتحديد ملف Web واجهة برمجة تطبيقات الخدمات: أ. عندما يتم تحديد
   a Web تظهر شاشة الموقع ، حدد أ webالموقع المراد إضافة الدليل الظاهري إليه ، ثم انقر فوق التالي.
   ب. انقر فوق Next للمتابعة. 6. عند اكتمال تثبيت API ، انقر فوق "إنهاء".

تكوين واجهة برمجة تطبيقات Changepoint لتكون على علم بالتخزين المؤقت
لتكوين واجهة برمجة تطبيقات Changepoint لتكون مدركًا لذاكرة التخزين المؤقت ، استبدل قيم "ذاكرة التخزين المؤقت. كلمة المرور "و" ذاكرة التخزين المؤقت. مفاتيح الخوادم في CP Web خدماتWeb.التكوين file مع القيم المستخدمة في المؤسسةWeb.التكوين file.
تمكين Web تحسينات الخدمات (WSE)

1. تعديل Web.التكوين file ل web خدمات. الموقع الافتراضي هو:
   APICP Web خدماتWeb.التكوين
2. ابحث عن المثيلات الثلاثة لسطر التعليق التالي:
   <! - قم بإلغاء التعليق على العنصر التالي إذا كنت تستخدم Web واجهة برمجة تطبيقات تحسينات الخدمة (WSE). اترك تعليقات إذا كنت تستخدم خدمات WCF ولا تقوم بالتثبيت Web تحسينات الخدمة (WSE) ->
3. قم بإلغاء التعليق على العنصر الذي يلي كل مثيل لسطر التعليق:
   <اسم القسم =”مايكروسوفت.web. الخدمات 2 ″…>webالخدمات>web. الخدمات 2>
   ملحوظة: الwebالخدمات> العنصر المراد عدم التعليق عليه هو عنصر تابع لـweb>.

تكوين التسجيل لملف Web خدمات API
يجب عليك ضبط السجل file مسار وتسجيل المستويات. مستويات السجل تراكمية. على سبيل المثالample ، إذا حددت المستوى 3 ، فسيتم تسجيل المستويات 1 و 2 و 3. مستوى السجل الافتراضي هو 8.

1. تعديل web خدمات Web.config. الموقع الافتراضي هو:
   APICP Web خدماتWeb.التكوين
2. اضبط السجلFileطريق. النظام الأساسي APIAPILogs. 3. تعيين LogLevel. القيم الصالحة هي:
   0 = لا تسجيل
   1 = كائن المصدر والطريقة
   2 = رسالة خطأ
   3 = معلمات الإدخال
   4 = عوائد
   5 = تحذير
   8 = نقطة تفتيش

تكوين مصادقة الدليل الظاهري لـ Web خدمات API
يجب تمكين الوصول المجهول وتعطيل مصادقة Windows المتكاملة لـ CPWebالدليل الظاهري للخدمة في خدمات معلومات الإنترنت (IIS). لمزيد من المعلومات ، راجع وثائق Microsoft IIS.
تكوين إعدادات اتصال قاعدة البيانات لـ Web خدمات API
استخدم الأداة المساعدة لإعدادات تسجيل الدخول لتشفير إعدادات اتصال قاعدة البيانات في ملف Web خدمات API Web.التكوين file. لمزيد من المعلومات ، ابحث عن "تكوين إعدادات اتصال قاعدة البيانات" في دليل تثبيت Changepoint.
تكوين المصادقة لـ Changepoint WCF Web خدمات
يمكنك تكوين مصادقة التطبيق والدخول الأحادي (SSO) لـ Changepoint WCF Web خدمات.
تتوفر خيارات التنفيذ التالية باستخدام Secure Token Service (STS):

• SSO باستخدام ISAPI SSL اختياري
• يلزم استخدام SSO باستخدام WS-Federation (ADFS 2.0) SSL

إذا كان SSL مطلوبًا ، يضمن برنامج التكوين أنه يتم استخدامه.
يمكن لنصوص التكوين لـ ISAPI ومصادقة التطبيق تمكين SSL اختياريًا.
تكوين مصادقة التطبيق لـ WCF Web خدمات
نوع المصادقة الافتراضي لـ Changepoint WCF Web الخدمات هي مصادقة التطبيق.
استخدم الإجراءات الواردة في هذا القسم من أجل:

• تكوين Changepoint WCF Web خدمات لاستخدام مصادقة التطبيق مع SSL
• العودة إلى Changepoint WCF Web خدمات مصادقة التطبيق بعد تنفيذ أحد تطبيقات SSO

تكوين PowerShell

1. افتح موجه Windows PowerShell.
2. تعديل سياسة التنفيذ:
   مجموعة تنفيذ السياسة غير المقيدة

Stagه 1 اجمع معلمات التكوين
تحديد قيم معلمات التكوين.

المعلمة	وصف
Webمسار_الخدمة	موقع Changepoint WCF Web خدمات web طلب files. تقصير: \ API \ CP Web خدمات
شهادة الخدمة_ اسم	اسم الشهادة الذي سيتم استخدامه لمصادقة الخدمة للعملاء باستخدام وضع أمان الرسائل. الافتراضي: اسم الشهادة "CN = ChangepointAPICertificate".
تتطلب HTTPS	طلب HTTPS (صواب / خطأ) الافتراضي: خطأ.

Stagه 2 تنفيذ سكربتات التكوين
استخدم قيم معلمات التكوين لتعديل تكوين ملف webالمواقع.

1.  افتح موجه PowerShell.
   ملحوظة: إذا تم تمكين التحكم في حساب المستخدم على الخادم ، فيجب عليك فتح موجه PowerShell باستخدام أذونات مسؤول مرتفعة.
2. انتقل إلى CP web دليل تكوين الخدمة ، الافتراضي:
   التكوينWebخدمة
3.  قم بتنفيذ ./Configuration_AppAuth.ps1
4. اتبع التعليمات.

تكوين تسجيل الدخول الأحادي (SSO) لـ WCF Web خدمات
تكوين PowerShell

1. افتح موجه Windows PowerShell.
2. تعديل سياسة التنفيذ:
   مجموعة تنفيذ السياسة غير المقيدة

تكوين SSO باستخدام ISAPI لـ WCF Web خدمات
Stagه 1 اجمع معلمات التكوين
حدد قيم معلمات التكوين التالية.

المعلمة	وصف
Webمسار_الخدمة	موقع Changepoint WCF Web خدمات web طلب files. تقصير: \ API \ CP Web خدمات
تتطلب HTTPS	طلب HTTPS (صواب / خطأ). الافتراضي: خطأ.
Changepoint_RSA_ تحويل ملفات تعريف الارتباط	اسم الشهادة التي تستخدمها لتشفير ملفات تعريف الارتباط. الافتراضي: اسم الشهادة "CN = ChangepointAPICertificate".
ServiceCertificate_Name	أدخل اسم الشهادة الذي سيتم استخدامه لمصادقة الخدمة للعملاء باستخدام وضع أمان الرسائل. الافتراضي: اسم الشهادة "CN = ChangepointAPICertificate".
SigningCertificate_Name	أدخل اسم شهادة التوقيع. هذا هو اسم الشهادة التي تستخدمها لتوقيع الرسائل. الافتراضي: اسم الشهادة "CN = ChangepointAPICertificate".
ISAPI_Mode	وضع ISAPI. الافتراضي: NT
ISAPI_Header	الرأس المستخدم عندما يكون ISAPI_Mode هو "HEADER" ، على سبيل المثالampلو فارغة.
نوع المطالبة	أدخل نوع مطالبة SSO. تقصير: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stagه 2 تنفيذ سكربتات التكوين

1. افتح موجه PowerShell.
   ملحوظة: إذا تم تمكين التحكم في حساب المستخدم على الخادم ، فيجب عليك فتح موجه PowerShell باستخدام أذونات مسؤول مرتفعة.
2. انتقل إلى CP web دليل تكوين الخدمة ، الافتراضي:
   التكوينWebخدمة
3. نفذ: ./Configuration_SSO_ISAPI.ps1
4. اتبع التعليمات.

تكوين SSO باستخدام WS-Federation (ADFS 2.0) لـ WCF Web خدمات
Stagه 1 اجمع معلمات التكوين
حدد قيم معلمات التكوين في الجدول أدناه. تأكد من أن ADFS_Server_URI في منطقة إنترانت لمستعرض المستخدم النهائي.
ملحوظة: بشكل افتراضي ، يتم تكوين Changepoint لتحديث المفاتيح العامة تلقائيًا التي يتم استخدامها لتوقيع رموز الأمان باستخدام مستند بيانات تعريف الاتحاد المنشور. في ADFS هذا هو:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
في بعض الحالات ، قد لا يكون من الممكن الوصول إلى خادم ADFS من Changepoint web لذلك سيكون عليك تحديث التكوين يدويًا بعد تشغيل برنامج التكوين النصي. للحصول على تفاصيل ، راجع "تحديث المفاتيح العامة يدويًا" في الصفحة 12.

المعلمة	وصف
Webمسار_الخدمة	موقع Changepoint WCF Web خدمات web طلب fileس. تقصير: \ API \ CP Web خدمات
WebService_URI	معرّف المجال الذي تستخدمه لـ Changepoint WCF Web خدمات. على سبيل المثالampجنيه ، https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	اسم الشهادة التي تستخدمها لتشفير ملفات تعريف الارتباط. الافتراضي: اسم الشهادة "CN = ChangepointApiCertificate".
ServiceCertificate_Name	اسم الشهادة الذي سيتم استخدامه لمصادقة الخدمة للعملاء باستخدام وضع أمان الرسائل. الافتراضي: اسم الشهادة "CN = ChangepointApiCertificate".
SigningCertificate_Name	اسم الشهادة التي تستخدمها لتوقيع الرسائل. الافتراضي: يتم استخدام اسم الشهادة "CN = ChangepointApiCertificate".
ADFS_FederationServiceName	اسم خدمة الاتحاد. للحصول على الاسم: من خادم ADFS ، قم بتشغيل وحدة إدارة ADFS 2.0. • حدد ADFS 2.0 من القائمة اليسرى. • من جزء الإجراءات ، حدد تحرير خصائص خدمة الاتحاد. اسم خدمة الاتحاد موجود في علامة التبويب عام.
نوع المطالبة	نوع مطالبة الدخول الموحّد (SSO). الافتراضي هو: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stagه 2 تنفيذ سكربتات التكوين
تكوين webالمواقع التي تستخدم قيم معلمات التكوين.

1. افتح موجه PowerShell.
   ملحوظة: إذا تم تمكين التحكم في حساب المستخدم على الخادم ، فيجب عليك فتح موجه PowerShell باستخدام أذونات مسؤول مرتفعة.
2. انتقل إلى Changepoint web دليل تكوين الخدمة ، الافتراضي: التكوينWebخدمة
3.  التنفيذ: ./Configuration_SSO_ADFS.ps1
4. اتبع التعليمات.

Stagه 3 قم بإنشاء ثقة الطرف المعتمد
قم بإنشاء Relying Party Trust في وحدة تحكم ADFS 2.0.

1. على خادم ADFS الخاص بك ، قم بتشغيل وحدة تحكم ADFS 2.0.
2. حدد إجراء> إضافة ثقة مجموعة معتمدة.
3. انقر فوق ابدأ.
4. حدد استيراد بيانات حول الجهة المعتمدة المنشورة عبر الإنترنت أو على شبكة محلية.
5. أدخل عنوان بيانات تعريف الاتحاد ، ثم انقر فوق التالي ، على سبيل المثالampعلى:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. أدخل اسم العرض ، على سبيل المثال Changepoint WCF API ، وانقر فوق التالي ، التالي ، التالي ، ثم إغلاق.
7. أضف قاعدة مطالبة لطرف Changepoint Relying المذكور أعلاه. بالنسبة إلى Changepoint ، اسم قاعدة المطالبة الافتراضي هو "UPN".
8. عيّن سمة LDAP "اسم المستخدم الأساسي" إلى نوع المطالبة الصادرة "* UPN" أو "UPN".

تحديث المفاتيح العامة يدويًا
للحصول على بصمة توقيع رمز خادم ADFS

1. من خادم ADFS ، قم بتشغيل وحدة إدارة ADFS 2.0.
2. حدد الخدمة> الشهادات ، وانقر نقرًا مزدوجًا فوق شهادة توقيع الرمز المميز.
3. حدد علامة التبويب "التفاصيل".
4. حدد حقل بصمة الإبهام.
5. للحصول على قيمة بصمة الإبهام ، قم بإزالة جميع المسافات بما في ذلك المساحة الأولى.

لتحديث Web.التكوين file

1. قم بتحرير ملف ADFS web.config. الموقع الافتراضي هو:
   المؤسسة: RP-STS_ADFS
2. تحت ، ابحث عن مفتاح ida: FederationMetadataLocation وقم بإلغاء تحديد قيمته:
   
3. تحت ، أعثر على العنصر واستبداله بما يلي: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust”/>

اختبار اتصال COM API

1. قم بتشغيل API Test Kit. الموقع الافتراضي هو:
   مكونات APIAPI
2. انقر فوق سلسلة الاتصال> Encrypter.
3. في حقل سلسلة اتصالات النص العادي:
   أ. استبدل SERVERNAME و DATABASENAME بمعلومات قاعدة البيانات الخاصة بك.
   ب. استبدل USERID و PASSWORD بمعلومات حساب مستخدم مسؤول قاعدة البيانات.
   ج. أدخل قيمة المهلة حسب الحاجة.
4. انقر فوق تشفير.
5. في حقل سلسلة الاتصال المشفرة ، انسخ النص.
6. إغلاق مربع الحوار.
7. في قائمة API Test Kit ، انقر فوق اتصال> اختبار اتصال COM API.
8. في علامة التبويب "الإصدار الحالي" ، الصق سلسلة الاتصال المشفرة في حقل سلسلة الاتصال.
9. في حقلي معرف تسجيل الدخول وكلمة المرور ، أدخل معرف تسجيل الدخول وكلمة المرور لحساب Changepoint الخاص بك.
10. في حقل مستوى السجل (0-8) ، حدد مستوى معلومات الخطأ التي سيتم إرجاعها في سجل COM API file إذا أظهرت نتيجة الاختبار مشكلة في الاتصال.
    0 = لا تسجيل
    1 = كائن المصدر والطريقة
    2 = رسالة خطأ
    3 = معلمات الإدخال
    4 = عوائد
    5 = تحذير
    8 = نقطة تفتيش
    الافتراضي هو 8.
11. انقر فوق "اتصال".
    إذا كان الاتصال ناجحًا ، يتم عرض رسالة نجاح في حقل النتيجة. إذا فشل الاتصال ، فتحقق من سجل COM API file عن الأخطاء. الموقع الافتراضي للسجل file يكون APIAPILogs.

التحقق من إصدار مكونات API المثبتة
يمكنك استخدام الأداة المساعدة لمدقق الإصدار للحصول على تفاصيل حول المكونات المثبتة ، بما في ذلك نسخة الإصدار والمسار.

1. قم بتشغيل CPVersionChecker.exe. المسار الافتراضي هو: مكونات APIAPI
2. انقر فوق قراءة.

التحقق من إصدار Web خدمات API

1. قم بتشغيل Internet Explorer من الخادم الذي يحتوي على ملف Web تم تثبيت واجهة برمجة تطبيقات الخدمات ، وأدخل العنوان:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  حيث المنفذ هو رقم المنفذ الخاص بـ webالموقع حيث قمت بتثبيت CPWebالدليل الظاهري للخدمة.
2. في صفحة WSLogin ، انقر فوق ارتباط GetVersion.
3. انقر فوق Invoke.

اختبار Web خدمات اتصال API

1. قم بتشغيل Internet Explorer من الخادم الذي يحتوي على ملف Web تم تثبيت واجهة برمجة تطبيقات الخدمات ، وأدخل العنوان: http://localhost.port/CPWeb.Service/WSLogin.asmx  حيث المنفذ هو رقم المنفذ الخاص بـ webالموقع حيث قمت بتثبيت CPWebالدليل الظاهري للخدمة.
2. في صفحة WSLogin ، انقر على رابط TestConnection.
3. انقر فوق Invoke. 4. في نتائج الاختبار:

• إذا العنصر غير صحيح ، نجح اختبار الاتصال.
• إذا العنصر صحيح ، فشل اختبار الاتصال. للمزيد من
  معلومات عن أسباب الفشل ، راجع و العناصر في نتائج الاختبار ، وتحقق من سجلات واجهة برمجة التطبيقات. المسار الافتراضي لسجلات API هو: APIAPILogs

إعداد Web خدمات API على خادم لغة

1. لنشر Changepoint Web واجهة برمجة تطبيقات الخدمات على خادم لغة ، يجب إضافة أو تحديث ملف tag في Web خدمات API web.config. الموقع الافتراضي لملف Web.التكوين file يكون: APICP Web خدماتWeb.التكوين
2. إذا كان tag موجودة بالفعل ، تأكد من أن سمات الثقافة و uiCulture هي "en-US".
3. إذا كان tag غير موجود بالفعل ، أضف ما يلي والتعليق و عناصرweb> العقدة:web>
   خيارات Visual Basic: تعيين صارم = "صواب" لعدم السماح بجميع تحويلات أنواع البيانات حيث يمكن أن يحدث فقدان البيانات. قم بتعيين صريح = "صحيح" لفرض التصريح عن جميع المتغيرات. ->
4. أعد تشغيل IIS.

المستندات / الموارد

برنامج Changepoint API [بي دي اف] دليل التثبيت API ، البرمجيات ، برامج API

مراجع

• دليل المستخدم