Changepoint API dasturiy ta'minotini o'rnatish bo'yicha qo'llanma

API o'rnatish bo'yicha qo'llanma
Malumot uchun qo'llanma
Oʻzgarish nuqtasi 2021

© 2021 Changepoint Canada ULC Barcha huquqlar himoyalangan. AQSH HUKUMAT HUQUQLARI-AQSh hukumati tomonidan foydalanish, takrorlash yoki oshkor qilish Changepoint Canada ULC litsenziya shartnomasida va DFARS 227.7202-1(a) va 227.7202-3(a) (1995) da koʻrsatilganidek cheklovlarga bogʻliq. DFARS 252.227-7013(c)(1)(ii) (Oktyabr 1988), FAR 12.212(a) (1995), FAR 52.227-19 yoki FAR 52.227-14 (ALT III), tegishlicha. Ushbu mahsulot Changepoint Canada ULC kompaniyasining maxfiy ma'lumotlari va tijorat sirlarini o'z ichiga oladi. Changepoint Canada ULC ning oldindan yozma ruxsatisiz oshkor qilish taqiqlanadi. Ushbu mahsulotdan foydalanish foydalanuvchining Changepoint Canada ULC bilan Litsenziya Shartnomasi shartlari va shartlariga bo'ysunadi. Hujjatlar faqat Litsenziat tomonidan ichki foydalanish uchun takrorlanishi mumkin. Ushbu hujjatning mazmuni Changepoint Canada ULC ning yozma roziligisiz o'zgartirilishi, o'zgartirilishi yoki o'zgartirilishi mumkin emas. Changepoint Canada ULC bu yerda koʻrsatilgan tarkibni istalgan vaqtda ogohlantirgan holda yoki ogohlantirmasdan oʻzgartirishi mumkin.

Tarkib yashirish

1 Changepoint API o'rnatilmoqda

2 COM API ulanishi sinovdan o'tkazilmoqda

3 Sinov Web Xizmatlar API ulanishi

4 Hujjatlar / manbalar

4.1 Ma'lumotnomalar

5 Tegishli xabarlar

Changepoint API o'rnatilmoqda

Changepoint API-ni o'rnatish haqida
Changepoint API COM API, Windows Communication Foundation (WCF) xizmati va orqaga qarab muvofiqlik uchun Web Xizmatlarni yaxshilash (WSE) xizmati. Changepoint API haqida ma'lumot olish uchun Changepoint API havolasiga qarang. Yangilanish qaydlari, ogohlantirishlar va ma'lum muammolar uchun Changepoint-dagi jamoa papkalaridagi Relizlar qaydlariga qarang.
Changepoint API yangilanmoqda
Agar siz Changepoint-ning oldingi versiyasidan yangilayotgan bo'lsangiz, ushbu versiyani o'rnatishdan oldin Changepoint API-ning oldingi versiyasini va uning komponentlarini o'chirish uchun Windows boshqaruv panelidan foydalaning.
Changepoint API talablari
Changepoint API-ni o'rnatishdan oldin Changepoint-ni o'rnatishingiz kerak. Dasturiy ta'minotga qo'yiladigan talablar uchun Changepoint dasturidagi 2021 yil uchun relizlar qaydlari va yamoqlari jamoasi papkasida mavjud bo'lgan Changepoint dasturiy ta'minot muvofiqligi matritsasiga qarang.
File yo'l konventsiyalari
Ushbu hujjatda umumiy yo'llar uchun quyidagi konventsiyalar qo'llaniladi:

Changepoint o'rnatilishining ildiz yo'li.
Standart yo'l:
C: Dastur Files (x86) ChangepointChangepoint
Login Settings yordam dasturi kabi umumiy Changepoint yordam dasturlari uchun ildiz joylashuvi.
Standart yo'l:
C: Dastur Files (x86) Umumiy FilesChangepointChangepoint

Changepoint API o'rnatilmoqda

Changepoint API media ildiz katalogidan setup.exe faylini ishga tushiring.
Xususiyatlarni tanlash ekrani paydo bo'lguncha ko'rsatmalarga amal qiling.
O'rnatmoqchi bo'lgan xususiyatlarni tanlang va "Keyingi" tugmasini bosing.
Standart API maqsad papkasini tanlang API-ni tanlang va Keyingiga bosing.
Eslatma: Changepoint Login Settings yordam dasturi o'rnatilgan Siz ko'rsatgan maqsad papkasidan qat'iy nazar LoginSettings.
Agar siz tanlagan bo'lsangiz Web Xizmatlar API: a. Tanlanganda
a Web Sayt ekrani paydo bo'ladi, a ni tanlang webvirtual katalogni qo'shish uchun saytni tanlang va "Keyingi" tugmasini bosing.
b. Davom etish uchun Keyingiga bosing. 6. APIni o'rnatish tugallangach, Finish tugmasini bosing.

Changepoint API-ni keshdan xabardor bo'lish uchun sozlash
Changepoint API-ni keshdan xabardor qilib sozlash uchun “kesh” qiymatini almashtiring. Parol" va "kesh. CPdagi serverlar” tugmachalari Web XizmatlarWeb.config file Korxonada ishlatiladigan qiymatlar bilanWeb.config file.
Yoqish Web Xizmatlarni yaxshilash (WSE)

ni tahrirlang Web.config file uchun web xizmatlar. Standart joylashuv:
APICP Web XizmatlarWeb.config
Quyidagi izoh qatorining uchta misolini toping:
< !– Agar foydalanayotgan bo'lsangiz, quyidagi elementni izohdan olib tashlang Web Service Enhancements (WSE) API. Agar WCF xizmatlaridan foydalansangiz va o'rnatmayotgan bo'lsangiz, sharhlaringizni qoldiring Web Xizmatni yaxshilash (WSE) ->
Sharh satrining har bir nusxasidan keyingi elementni izohdan olib tashlang:
<bo'lim nomi="microsoft.web.xizmatlar2″ … >webXizmatlar>web.xizmatlar2>
Eslatma: ThewebXizmatlar> izoh qoldiriladigan elementning farzandi hisoblanadiweb>.

uchun jurnalni yozishni sozlash Web Xizmatlar API
Jurnalni o'rnatishingiz kerak file yo'l va jurnal darajalari. Jurnal darajalari kümülatifdir. Misol uchunample, agar siz 3-darajani belgilasangiz, u holda 1, 2 va 3 darajalar qayd qilinadi. Standart jurnal darajasi - 8.

ni tahrirlang web xizmatlar Web.config. Standart joylashuv:
APICP Web XizmatlarWeb.config
Jurnalni o'rnatingFileYo'l. Standart qiymat APIAPILloglar. 3. LogLevelni o'rnating. To'g'ri qiymatlar:
0 = Ro'yxatdan o'tish yo'q
1 = Manba ob'ekti va usuli
2 = Xato xabari
3 = Kirish parametrlari
4 = Qaytadi
5 = Ogohlantirish
8 = Tekshirish punkti

uchun virtual katalog autentifikatsiyasini sozlash Web Xizmatlar API
Siz anonim kirishni yoqishingiz va CP uchun Integrated Windows autentifikatsiyasini o'chirib qo'yishingiz kerakWebInternet Information Services (IIS) da xizmat virtual katalogi. Qo'shimcha ma'lumot olish uchun Microsoft IIS hujjatlariga qarang.
Ma'lumotlar bazasiga ulanish sozlamalarini sozlash Web Xizmatlar API
Ma'lumotlar bazasiga ulanish sozlamalarini shifrlash uchun Kirish sozlamalari yordam dasturidan foydalaning Web Xizmatlar API Web.config file. Qo'shimcha ma'lumot olish uchun Changepoint o'rnatish qo'llanmasida "Ma'lumotlar bazasi ulanish sozlamalarini sozlash" ni qidiring.
Changepoint WCF uchun autentifikatsiyani sozlash Web Xizmatlar
Changepoint WCF uchun Ilova autentifikatsiyasini va yagona tizimga kirishni (SSO) sozlashingiz mumkin Web Xizmatlar.
Secure Token Service (STS) yordamida quyidagi amalga oshirish imkoniyatlari mavjud:

ISAPI SSL yordamida SSO ixtiyoriy
WS-Federation (ADFS 2.0) SSL yordamida SSO talab qilinadi

Agar SSL kerak bo'lsa, konfiguratsiya skripti uning ishlatilishini ta'minlaydi.
ISAPI va ilovalarni autentifikatsiya qilish uchun konfiguratsiya skriptlari ixtiyoriy ravishda SSLni yoqishi mumkin.
WCF uchun ilova autentifikatsiyasini sozlash Web Xizmatlar
Changepoint WCF uchun standart autentifikatsiya turi Web Xizmatlar ilova autentifikatsiyasidir.
Ushbu bo'limdagi protseduralardan foydalaning:

Changepoint WCF ni sozlang Web SSL bilan ilova autentifikatsiyasidan foydalanish xizmatlari
WCF o'zgartirish nuqtasini qaytarish Web SSO dasturlaridan birini amalga oshirgandan so'ng ilovani autentifikatsiya qilish xizmatlari

PowerShell-ni sozlang

Windows PowerShell taklifini oching.
Amalga oshirish siyosatini o'zgartiring:
Oʻrnatish-ExecutionPolicy Cheklanmagan

Stage 1 Konfiguratsiya parametrlarini to'plash
Konfiguratsiya parametrlari uchun qiymatlarni aniqlang.

Parametr	Tavsif
WebService_Path	Changepoint WCF joylashuvi Web Xizmatlar web ilova files. Standart: \API\CP Web Xizmatlar
Xizmat sertifikati_ Ism	Xabar xavfsizligi rejimidan foydalangan holda mijozlarga xizmatni autentifikatsiya qilish uchun foydalaniladigan sertifikat nomi. Standart: “CN=ChangepointAPICertificate” sertifikat nomi.
HTTPS talab qiladi	HTTPS talab qilish (toʻgʻri/notoʻgʻri) Standart: False.

Stage 2 Konfiguratsiya skriptlarini bajarish
Konfiguratsiyani o'zgartirish uchun konfiguratsiya parametrlari qiymatlaridan foydalaning websaytlar.

PowerShell taklifini oching.
Eslatma: Agar serveringizda foydalanuvchi hisobini boshqarish yoqilgan bo'lsa, yuqori ma'mur ruxsatlaridan foydalangan holda PowerShell taklifini ochishingiz kerak.
CP ga o'ting web xizmat konfiguratsiya katalogi, standart:
KonfiguratsiyaCPWebXizmat
./Configuration_AppAuth.ps1 dasturini ishga tushiring
Ko'rsatmalarga amal qiling.

WCF uchun yagona tizimga kirish (SSO) sozlanmoqda Web Xizmatlar
PowerShell-ni sozlang

Windows PowerShell taklifini oching.
Amalga oshirish siyosatini o'zgartiring:
Oʻrnatish-ExecutionPolicy Cheklanmagan

WCF uchun ISAPI yordamida SSO konfiguratsiyasi Web Xizmatlar
Stage 1 Konfiguratsiya parametrlarini to'plash
Quyidagi konfiguratsiya parametrlari uchun qiymatlarni aniqlang.

Parametr	Tavsif
WebService_Path	Changepoint WCF joylashuvi Web Xizmatlar web ilova files. Standart: \API\CP Web Xizmatlar
HTTPS talab qiladi	HTTPS talab qilish (to'g'ri/noto'g'ri). Standart: False.
Changepoint_RSA_ Cookie_Transform	Cookie shifrlash uchun foydalanadigan sertifikat nomi. Standart: “CN=ChangepointAPICertificate” sertifikat nomi.
Xizmat sertifikati_nomi	Xabar xavfsizligi rejimidan foydalangan holda mijozlarga xizmatni autentifikatsiya qilish uchun foydalaniladigan sertifikat nomini kiriting. Standart: “CN=ChangepointAPICertificate” sertifikat nomi.
Imzolash sertifikati_nomi	Imzo sertifikati nomini kiriting. Bu siz xabarlarni imzolash uchun foydalanadigan sertifikatning nomi. Standart: “CN=ChangepointAPICertificate” sertifikat nomi.
ISAPI_Mode	ISAPI rejimi. Standart: NT
ISAPI_Header	ISAPI_Mode "HEADER" bo'lganda ishlatiladigan sarlavha, masalanample, bo'sh.
Da'vo turi	SSO da'vo turini kiriting. Standart: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Konfiguratsiya skriptlarini bajarish

PowerShell taklifini oching.
Eslatma: Agar serveringizda foydalanuvchi hisobini boshqarish yoqilgan bo'lsa, yuqori ma'mur ruxsatlaridan foydalangan holda PowerShell taklifini ochishingiz kerak.
CP ga o'ting web xizmat konfiguratsiya katalogi, standart:
KonfiguratsiyaCPWebXizmat
Bajarish: ./Configuration_SSO_ISAPI.ps1
Ko'rsatmalarga amal qiling.

WCF uchun WS-Federation (ADFS 2.0) yordamida SSO ni sozlash Web Xizmatlar
Stage 1 Konfiguratsiya parametrlarini to'plash
Quyidagi jadvaldagi konfiguratsiya parametrlari qiymatlarini aniqlang. ADFS_Server_URI oxirgi foydalanuvchi brauzerining Intranet zonasida ekanligiga ishonch hosil qiling.
Eslatma: Odatiy bo'lib, Changepoint nashr etilgan federatsiya metama'lumotlar hujjati yordamida xavfsizlik tokenlarini imzolash uchun foydalaniladigan ochiq kalitlarni avtomatik yangilash uchun tuzilgan. ADFSda bu:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Ba'zi hollarda Changepoint orqali ADFS serveriga kirish imkoni bo'lmasligi mumkin web server, shuning uchun konfiguratsiya skriptini ishga tushirgandan so'ng konfiguratsiyani qo'lda yangilashingiz kerak bo'ladi. Tafsilotlar uchun 12-betdagi “Ochiq kalitlarni qo‘lda yangilash”ga qarang.

Parametr	Tavsif
WebService_Path	Changepoint WCF joylashuvi Web Xizmatlar web ilova files. Standart: \API\CP Web Xizmatlar
WebService_URI	Changepoint WCF uchun foydalanadigan domen identifikatori Web Xizmatlar. Misol uchunample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Cookie shifrlash uchun foydalanadigan sertifikat nomi. Standart: “CN=ChangepointApiCertificate” sertifikat nomi.
Xizmat sertifikati_nomi	Xabar xavfsizligi rejimidan foydalangan holda mijozlarga xizmatni autentifikatsiya qilish uchun foydalaniladigan sertifikat nomi. Standart: “CN=ChangepointApiCertificate” sertifikat nomi.
Imzolash sertifikati_nomi	Xabarlarni imzolash uchun foydalanadigan sertifikat nomi. Standart: “CN=ChangepointApiCertificate” sertifikat nomi ishlatiladi.
ADFS_ FederationServiceName	Federatsiya xizmati nomi. Nomni olish uchun: ADFS serveridan ADFS 2.0 boshqaruv konsolini ishga tushiring. •Chap menyudan ADFS 2.0 ni tanlang. •Amallar panelidan Federatsiya xizmatining xususiyatlarini tahrirlash-ni tanlang. Federatsiya xizmati nomi Umumiy yorlig'ida joylashgan.
Da'vo turi	SSO daʼvo turi. Standart: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Konfiguratsiya skriptlarini bajarish
ni sozlang webkonfiguratsiya parametrlari qiymatlaridan foydalanadigan saytlar.

PowerShell taklifini oching.
Eslatma: Agar serveringizda foydalanuvchi hisobini boshqarish yoqilgan bo'lsa, yuqori ma'mur ruxsatlaridan foydalangan holda PowerShell taklifini ochishingiz kerak.
O'zgartirish nuqtasiga o'ting web xizmat konfiguratsiya katalogi, standart: KonfiguratsiyaCPWebXizmat
Bajarish: ./Configuration_SSO_ADFS.ps1
Ko'rsatmalarga amal qiling.

Stage 3 Ishonchli tomonlar ishonchini yaratish
ADFS 2.0 konsolida ishonchli partiya ishonchini yarating.

ADFS serveringizda ADFS 2.0 konsolini ishga tushiring.
Action > Relying Party Trust-ni qo'shish-ni tanlang.
Start tugmasini bosing.
Onlayn yoki mahalliy tarmoqda chop etilgan ishonchli tomon haqidagi maʼlumotlarni import qilish-ni tanlang.
Federatsiya meta-ma'lumotlari manzilini kiriting va keyin "Keyingi" tugmasini bosing, masalanampga:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
Displey nomini kiriting, masalan, Changepoint WCF API va Keyingi, Keyingi, Keyingi, keyin Yopish tugmasini bosing.
Yuqoridagi o'zgartirish nuqtasiga ishonuvchi tomon uchun da'vo qoidasini qo'shing. Changepoint uchun standart daʼvo qoidasi nomi “UPN” hisoblanadi.
LDAP atributini “User-Principal-Name” bilan “* UPN” yoki “UPN” chiquvchi daʼvo turiga moslang.

Umumiy kalitlarni qo'lda yangilash
ADFS Server token imzolash bosh barmoq izini olish uchun

ADFS serveridan ADFS 2.0 boshqaruv konsolini ishga tushiring.
Xizmat > Sertifikatlar-ni tanlang va Token imzolash sertifikatiga ikki marta bosing.
Tafsilotlar yorlig'ini tanlang.
Bosh barmoq izi maydonini tanlang.
Bosh barmoq izi qiymatini olish uchun barcha boʻshliqlarni, shu jumladan birinchi boʻshliqni olib tashlang.

Yangilash uchun Web.config file

ADFSni tahrirlang web.config. Standart joylashuv:
EnterpriseRP-STS_ADFS
Ostida element uchun ida:FederationMetadataLocation kalitini toping va uning qiymatini tozalang:
ostida , toping elementni kiriting va uni quyidagi bilan almashtiring: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

COM API ulanishi sinovdan o'tkazilmoqda

API test to'plamini ishga tushiring. Standart joylashuv:
APIAPI ComponentsApiTestKit.exe.
Ulanish satri > Encrypter-ni bosing.
Oddiy matnli ulanishlar qatorida:
a. SERVERNAME va DATABASENAME ni maʼlumotlar bazasi maʼlumotlari bilan almashtiring.
b. USERID va PASSWORD ni maʼlumotlar bazasi administratori foydalanuvchi hisobi maʼlumotlari bilan almashtiring.
c. Vaqt tugashi qiymatini kerak bo'lganda kiriting.
Shifrlash-ni bosing.
Shifrlangan ulanish satri maydonida matnni nusxalash.
Muloqot oynasini yoping.
API test to'plami menyusida Ulanish > COM API ulanish sinovchisi-ni bosing.
Joriy versiya yorlig'ida shifrlangan ulanish qatorini Ulanish satriga joylashtiring.
LoginId va Password maydonlarida Changepoint hisobingiz uchun login ID va parolni kiriting.
Loglevel (0-8) maydonida COM API jurnalida qaytariladigan xato ma'lumotlari darajasini belgilang. file agar test natijasi ulanish bilan bog'liq muammoni ko'rsatsa.
0 = Ro'yxatdan o'tish yo'q
1 = Manba ob'ekti va usuli
2 = Xato xabari
3 = Kirish parametrlari
4 = Qaytadi
5 = Ogohlantirish
8 = Tekshirish punkti
Standart 8.
Ulanish-ni bosing.
Agar ulanish muvaffaqiyatli bo'lsa, Natija maydonida muvaffaqiyat haqida xabar ko'rsatiladi. Agar ulanish muvaffaqiyatsiz bo'lsa, COM API jurnalini tekshiring file xatolar uchun. Jurnalning standart joylashuvi file hisoblanadi APIAPILloglar.

O'rnatilgan API komponentlari versiyasini tekshirish
O'rnatilgan komponentlar, jumladan, versiya va yo'l haqida ma'lumot olish uchun versiya tekshiruvi yordam dasturidan foydalanishingiz mumkin.

CPVersionChecker.exe faylini ishga tushiring. Standart yo'l: APIAPI komponentlari
O'qish-ni bosing.

versiyasini tekshirish Web Xizmatlar API

joylashgan serverdan Internet Explorer-ni ishga tushiring Web Services API o'rnatildi va manzilni kiriting:
http://localhost.port/CPWeb.Service/WSLogin.asmx bu erda port - bu port raqami webCPni o'rnatgan saytWebXizmat virtual katalogi.
WSLogin sahifasida GetVersion havolasini bosing.
Chaqiruv tugmasini bosing.

Sinov Web Xizmatlar API ulanishi

joylashgan serverdan Internet Explorer-ni ishga tushiring Web Services API o'rnatildi va manzilni kiriting: http://localhost.port/CPWeb.Service/WSLogin.asmx bu erda port - bu port raqami webCPni o'rnatgan saytWebXizmat virtual katalogi.
WSLogin sahifasida TestConnection havolasini bosing.
Chaqiruv tugmasini bosing. 4. Sinov natijalarida:

Agar element noto'g'ri, sinov ulanishi muvaffaqiyatli bo'ldi.
Agar element rost, sinov ulanishi amalga oshmadi. Ko'proq ma'lumot uchun
muvaffaqiyatsizlik sabablari haqida ma'lumot, qarang va test natijalaridagi elementlarni tekshiring va API jurnallarini tekshiring. API jurnallarining standart yo'li: APIAPILloglar

ni sozlash Web Til serveridagi xizmatlar API

O'zgartirish nuqtasini joylashtirish uchun Web Til serveridagi Services API, siz qo'shishingiz yoki yangilashingiz kerak tag ichida Web Xizmatlar API web.config. Standart joylashuvi Web.config file bu: APICP Web XizmatlarWeb.config
Agar tag allaqachon mavjud boʻlsa, madaniyat va uiCulture atributlari “en-US” ekanligini tekshiring.
Agar tag allaqachon mavjud emas, quyidagilarni qo'shing , sharh va uchun elementlarweb> tugun:web>
Visual Basic opsiyalari: Ma'lumotlar yo'qolishi mumkin bo'lgan barcha ma'lumotlar turini o'zgartirishga ruxsat bermaslik uchun qat'iy =" true" ni o'rnating. Barcha o'zgaruvchilarni majburiy e'lon qilish uchun aniq = "true" ni o'rnating. –>
IIS -ni qayta ishga tushiring.