Udhëzuesi i instalimit të API
Udhëzues referimi
Pika e ndryshimit 2021
© 2021 Changepoint Canada ULC Të gjitha të drejtat e rezervuara. TË DREJTAT E QEVERISË SË SH.B.A.-së-Përdorimi, dyfishimi ose zbulimi nga Qeveria e SHBA-së i nënshtrohet kufizimeve të përcaktuara në marrëveshjen e licencës Changepoint Canada ULC dhe siç parashikohet në DFARS 227.7202-1(a) dhe 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, ose FAR 52.227-14 (ALT III), sipas zbatimit. Ky produkt përmban informacione konfidenciale dhe sekrete tregtare të Changepoint Canada ULC. Zbulimi është i ndaluar pa lejen paraprake të shprehur me shkrim të Changepoint Canada ULC. Përdorimi i këtij produkti është subjekt i termave dhe kushteve të Marrëveshjes së Licencës së përdoruesit me Changepoint Canada ULC. Dokumentacioni mund të riprodhohet vetëm nga i Licencuari për përdorim të brendshëm. Përmbajtja e këtij dokumenti nuk mund të ndryshohet, modifikohet ose ndryshohet pa pëlqimin e shprehur me shkrim të Changepoint Canada ULC. Changepoint Canada ULC mund të ndryshojë përmbajtjen e specifikuar këtu në çdo kohë, me ose pa njoftim.
Instalimi i Changepoint API
Rreth instalimit të Changepoint API
Changepoint API është i disponueshëm si një API COM, një shërbim i Windows Communication Foundation (WCF) dhe, për pajtueshmërinë e pasme, si një Web Shërbimi i Përmirësimeve të Shërbimeve (WSE). Për informacion rreth Changepoint API, shihni Referencën e API-së Changepoint. Për shënimet e përmirësimit, paralajmërimet dhe çështjet e njohura, shihni Shënimet e publikimit në dosjet e ekipit në Changepoint.
Përmirësimi i API-së Changepoint
Nëse po përmirësoni nga një version i mëparshëm i Changepoint, përdorni Panelin e Kontrollit të Windows për të çinstaluar versionin e mëparshëm të Changepoint API dhe përbërësit e tij përpara se të instaloni këtë version.
Kërkesat e Changepoint API
Duhet të instaloni Changepoint përpara se të instaloni Changepoint API. Për kërkesat e softuerit, shihni Matricën e Përputhshmërisë së Softuerit Changepoint, e cila është e disponueshme në dosjen e ekipit të Shënimeve të Publikimit dhe Arnave 2021 në Changepoint.
File konventat e rrugës
Përgjatë këtij dokumenti, konventat e mëposhtme përdoren për shtigjet e zakonshme:
- Rruga rrënjësore e instalimit të Changepoint.
Rruga e paracaktuar është:
C: Programi Files (x86)Pika e ndryshimit Pika e ndryshimit - Vendndodhja e rrënjës për shërbimet e zakonshme të Changepoint, siç është mjeti "Cilësimet e hyrjes".
Rruga e paracaktuar është:
C: Programi Files (x86) E zakonshme FilesChangepointPika e ndryshimit
Instalimi i Changepoint API
- Nga direktoria rrënjësore e medias Changepoint API, ekzekutoni setup.exe.
- Ndiqni kërkesat derisa të shfaqet ekrani Select Features.
- Zgjidhni veçoritë që dëshironi të instaloni, më pas klikoni Next.
- Zgjidhni dosjen e destinacionit API, e paracaktuar API, dhe klikoni Next.
Shënim: Programi Changepoint Login Settings është i instaluar në LoginSettings, pavarësisht nga dosja e destinacionit që specifikoni. - Nëse keni zgjedhur Web Shërbimet API: a. Kur zgjidhni
a Web Shfaqet ekrani i sajtit, zgjidhni një webfaqe për të shtuar drejtorinë virtuale dhe më pas klikoni Next.
b. Kliko Next për të vazhduar. 6. Kur instalimi i API të përfundojë, klikoni Finish.
Konfigurimi i Changepoint API për të qenë i vetëdijshëm për cache
Për të konfiguruar Changepoint API që të jetë i vetëdijshëm për cache, zëvendësoni vlerat për "cache. Fjalëkalimi" dhe "cache. Serverët” në CP Web ShërbimetWeb.konfigurim file me vlerat e përdorura në NdërmarrjeWeb.konfigurim file.
Duke mundësuar Web Përmirësimet e shërbimeve (WSE)
- Redaktoni Web.konfigurim file për web shërbimet. Vendndodhja e paracaktuar është:
APICP Web ShërbimetWeb.konfigurim - Gjeni tre shembujt e rreshtit të komenteve të mëposhtme:
< !– Çkomentoni elementin e mëposhtëm nëse jeni duke përdorur Web API për përmirësimet e shërbimit (WSE). Lini komente nëse përdorni shërbimet WCF dhe nuk po instaloni Web Përmirësimet e Shërbimit (WSE) –> - Çkomentoni elementin që ndjek çdo shembull të rreshtit të komenteve:
<section name=”microsoft.web.shërbime2″ … >webShërbimet>web.shërbimet2>
Shënim: TëwebShërbimet> elementi që duhet të mos komentohet është një fëmijë iweb>.
Konfigurimi i regjistrimit për Web Shërbimet API
Ju duhet të vendosni regjistrin file nivelet e rrugës dhe regjistrit. Nivelet e regjistrave janë kumulative. Për shembullample, nëse specifikoni nivelin 3, atëherë nivelet 1, 2 dhe 3 regjistrohen. Niveli i paracaktuar i regjistrit është 8.
- Redaktoni web shërbimet Web.konfigurim. Vendndodhja e paracaktuar është:
APICP Web ShërbimetWeb.konfigurim - Vendosni RegjistrinFileRrugë. Vlera e paracaktuar është APIAPIlogs. 3. Vendosni LogLevel. Vlerat e vlefshme janë:
0 = Nuk ka prerje
1 = Objekti dhe metoda burimore
2 = Mesazh gabimi
3 = Parametrat e hyrjes
4 = Kthimet
5 = Paralajmërim
8 = Pika kontrolli
Konfigurimi i vërtetimit të drejtorisë virtuale për Web Shërbimet API
Duhet të aktivizoni aksesin anonim dhe të çaktivizoni vërtetimin e integruar të Windows për CPWebDrejtoria virtuale e shërbimit në Shërbimet e Informacionit të Internetit (IIS). Për më shumë informacion, shihni dokumentacionin e Microsoft IIS.
Konfigurimi i cilësimeve të lidhjes së bazës së të dhënave për Web Shërbimet API
Përdorni mjetin Login Settings për të enkriptuar cilësimet e lidhjes së bazës së të dhënave në Web Shërbimet API Web.konfigurim file. Për më shumë informacion, kërkoni për "Konfigurimi i cilësimeve të lidhjes së bazës së të dhënave" në udhëzuesin e instalimit të Changepoint.
Konfigurimi i vërtetimit për Changepoint WCF Web Shërbimet
Ju mund të konfiguroni Autentifikimin e aplikacionit dhe hyrjen e vetme (SSO) për Changepoint WCF Web Shërbimet.
Opsionet e mëposhtme të zbatimit janë të disponueshme duke përdorur Shërbimin Secure Token (STS):
- SSO duke përdorur ISAPI SSL opsionale
- Kërkohet SSO duke përdorur WS-Federation (ADFS 2.0) SSL
Nëse kërkohet SSL, skripti i konfigurimit siguron që ai të përdoret.
Skriptet e konfigurimit për ISAPI dhe autentifikimin e aplikacionit mund të mundësojnë opsionalisht SSL.
Konfigurimi i vërtetimit të aplikacionit për WCF Web Shërbimet
Lloji i parazgjedhur i vërtetimit për Changepoint WCF Web Shërbimet janë vërtetimi i aplikacionit.
Përdorni procedurat në këtë seksion për të:
- konfiguroni Changepoint WCF Web Shërbimet për të përdorur vërtetimin e aplikacionit me SSL
- ktheni Changepoint WCF Web Shërbimet për vërtetimin e aplikacionit pasi të ketë zbatuar një nga implementimet e SSO
Konfiguro PowerShell
- Hapni një kërkesë Windows PowerShell.
- Ndryshoni politikën e ekzekutimit:
Set-ExecutionPolicy e pakufizuar
Stage 1 Mblidhni parametrat e konfigurimit
Përcaktoni vlerat për parametrat e konfigurimit.
| Parametri | Përshkrimi |
| WebShërbimi_Shtegu | Vendndodhja e Changepoint WCF Web Shërbimet web aplikimi files. E parazgjedhur: \API\CP Web Shërbimet |
| Certifikata e Shërbimit_ Emri |
Emri i certifikatës që do të përdoret për të vërtetuar shërbimin për klientët duke përdorur modalitetin e sigurisë së mesazheve. Parazgjedhja: Emri i certifikatës “CN=ChangepointAPICertificate”. |
| kërkojnë HTTPS | Kërkohet HTTPS (E vërtetë/E gabuar) Parazgjedhja: E rreme. |
Stage 2 Ekzekutoni skriptet e konfigurimit
Përdorni vlerat për parametrat e konfigurimit për të modifikuar konfigurimin e webfaqet.
- Hapni një kërkesë të PowerShell.
Shënim: Nëse serveri juaj ka të aktivizuar Kontrollin e Llogarisë së Përdoruesit, duhet të hapni kërkesën e PowerShell duke përdorur leje të ngritura të administratorit. - Navigoni te CP web Drejtoria e konfigurimit të shërbimit, e paracaktuar:
Konfigurimi CPWebShërbimi - Ekzekutoni ./Configuration_AppAuth.ps1
- Ndiqni udhëzimet.
Konfigurimi i hyrjes së vetme (SSO) për WCF Web Shërbimet
Konfiguro PowerShell
- Hapni një kërkesë Windows PowerShell.
- Ndryshoni politikën e ekzekutimit:
Set-ExecutionPolicy e pakufizuar
Konfigurimi i SSO duke përdorur ISAPI për WCF Web Shërbimet
Stage 1 Mblidhni parametrat e konfigurimit
Përcaktoni vlerat për parametrat e mëposhtëm të konfigurimit.
| Parametri | Përshkrimi |
| WebShërbimi_Shtegu | Vendndodhja e Changepoint WCF Web Shërbimet web aplikimi files. E parazgjedhur: \API\CP Web Shërbimet |
| kërkojnë HTTPS | Kërkohet HTTPS (E vërtetë/E gabuar). Parazgjedhja: E rreme. |
| Pika e ndryshimit_RSA_ Cookie_Transform |
Emri i certifikatës që përdorni për enkriptimin e Cookie. Parazgjedhja: Emri i certifikatës “CN=ChangepointAPICertificate”. |
| Emri_Certifikata e Shërbimit | Futni emrin e certifikatës që do të përdoret për të vërtetuar shërbimin për klientët duke përdorur modalitetin e sigurisë së mesazheve. Parazgjedhja: Emri i certifikatës “CN=ChangepointAPICertificate”. |
| Nënshkrimi_Emri i Certifikatës | Futni emrin e certifikatës së nënshkrimit. Ky është emri i certifikatës që përdorni për nënshkrimin e mesazheve. Parazgjedhja: Emri i certifikatës “CN=ChangepointAPICertificate”. |
| ISAPI_Mode | Mënyra ISAPI. Parazgjedhja: NT |
| ISAPI_Header | Titulli i përdorur kur ISAPI_Mode është "HEADER", p.shample, bosh. |
| Lloji i Kërkesës | Futni llojin e pretendimit të SSO. E parazgjedhur: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Ekzekutoni skriptet e konfigurimit
- Hapni një kërkesë të PowerShell.
Shënim: Nëse serveri juaj ka të aktivizuar Kontrollin e Llogarisë së Përdoruesit, duhet të hapni kërkesën e PowerShell duke përdorur leje të ngritura të administratorit. - Navigoni te CP web Drejtoria e konfigurimit të shërbimit, e paracaktuar:
Konfigurimi CPWebShërbimi - Ekzekutoni: ./Configuration_SSO_ISAPI.ps1
- Ndiqni udhëzimet.
Konfigurimi i SSO duke përdorur WS-Federation (ADFS 2.0) për WCF Web Shërbimet
Stage 1 Mblidhni parametrat e konfigurimit
Përcaktoni vlerat për parametrat e konfigurimit në tabelën më poshtë. Sigurohuni që ADFS_Server_URI të jetë në zonën e Intranetit të shfletuesit të përdoruesit fundor.
Shënim: Si parazgjedhje, Changepoint është konfiguruar që të përditësojë automatikisht çelësat publikë që përdoren për të nënshkruar argumentet e sigurisë duke përdorur dokumentin e publikuar të meta të dhënave të federatës. Në ADFS kjo është:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Në disa raste mund të mos jetë e mundur të arrihet te serveri ADFS nga pika e ndryshimit web server kështu që do t'ju duhet të përditësoni manualisht konfigurimin pasi të keni ekzekutuar skriptin e konfigurimit. Për detaje, shihni “Përditësimi manual i çelësave publikë” në faqen 12.
| Parametri | Përshkrimi |
| WebShërbimi_Shtegu | Vendndodhja e Changepoint WCF Web Shërbimet web aplikimi files. E parazgjedhur: \API\CP Web Shërbimet |
| WebShërbimi_URI | Identifikuesi i domenit që përdorni për Changepoint WCF Web Shërbimet. Për shembullample., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_ Cookie_Transform | Emri i certifikatës që përdorni për enkriptimin e Cookie. Parazgjedhja: Emri i certifikatës “CN=ChangepointApiCertificate”. |
| Emri_Certifikata e Shërbimit | Emri i certifikatës që do të përdoret për të vërtetuar shërbimin për klientët duke përdorur modalitetin e sigurisë së mesazheve. Parazgjedhja: Emri i certifikatës “CN=ChangepointApiCertificate”. |
| Nënshkrimi_Emri i Certifikatës | Emri i certifikatës që përdorni për nënshkrimin e mesazheve. Parazgjedhja: përdoret emri i certifikatës “CN=ChangepointApiCertificate”. |
| ADFS_ Emri i Shërbimit të Federatës | Emri i Shërbimit të Federatës. Për të marrë emrin: Nga serveri ADFS, hapni konsolën e menaxhimit ADFS 2.0. •Zgjidhni ADFS 2.0 nga menyja e majtë. •Nga paneli Veprimi zgjidhni Edit Federation Service Properties. Emri i Shërbimit të Federatës është në skedën e Përgjithshme. |
| Lloji i Kërkesës | Lloji i pretendimit të SSO. Parazgjedhja është: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Ekzekutoni skriptet e konfigurimit
Konfiguro webfaqet duke përdorur vlerat për parametrat e konfigurimit.
- Hapni një kërkesë të PowerShell.
Shënim: Nëse serveri juaj ka të aktivizuar Kontrollin e Llogarisë së Përdoruesit, duhet të hapni kërkesën e PowerShell duke përdorur leje të ngritura të administratorit. - Navigoni te pika e ndryshimit web Drejtoria e konfigurimit të shërbimit, e paracaktuar: Konfigurimi CPWebShërbimi
- Ekzekutoni: ./Configuration_SSO_ADFS.ps1
- Ndiqni udhëzimet.
Stage 3 Krijoni besimin e palës së mbështetur
Krijoni Trustin e Partisë së Mbështetur në Konsolën ADFS 2.0.
- Në serverin tuaj ADFS, hapni tastierën ADFS 2.0.
- Zgjidhni Veprim > Shto besimin e palës së mbështetur.
- Klikoni Start.
- Zgjidhni Importo të dhëna për palën mbështetëse të publikuara në internet ose në një rrjet lokal.
- Futni adresën e meta të dhënave të Federatës dhe më pas klikoni Tjetër, për shembullampe:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Futni një emër të shfaqur, p.sh. Changepoint WCF API, dhe klikoni Next, Next, Next, pastaj Close.
- Shtoni një rregull pretendimi për Palën e Mbështetshme të Pikës së Ndryshimit të mësipërm. Për Changepoint, emri i parazgjedhur i rregullit të pretendimit është "UPN".
- Harto atributin LDAP "User-Principal-Name" në llojin e pretendimit dalës "* UPN" ose "UPN".
Përditësimi manual i çelësave publikë
Për të marrë gjurmën e gishtit të nënshkrimit të shenjës së serverit ADFS
- Nga serveri ADFS, hapni tastierën e menaxhimit ADFS 2.0.
- Zgjidhni Shërbimi > Certifikatat dhe klikoni dy herë mbi certifikatën e nënshkrimit të shenjës.
- Zgjidhni skedën Detajet.
- Zgjidhni fushën Thumbprint.
- Për të marrë vlerën e gjurmës së gishtit, hiqni të gjitha hapësirat duke përfshirë hapësirën e parë.
Për të përditësuar Web.konfigurim file
- Redaktoni ADFS web.konfigurim. Vendndodhja e paracaktuar është:
Ndërmarrja RP-STS_ADFS - Nën elementin, gjeni çelësin ida:FederationMetadataLocation dhe pastroni vlerën e tij:
- Nën , Gjej element dhe zëvendësojeni atë me sa vijon: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />
Testimi i lidhjes COM API
- Ekzekutoni kompletin e testit API. Vendndodhja e paracaktuar është:
APIAPI ComponentsApiTestKit.exe. - Klikoni Vargun e Lidhjes > Enkriptuesi.
- Në fushën e vargut të lidhjeve të tekstit të thjeshtë:
a. Zëvendësoni SERVERNAME dhe DATABASENAME me informacionin tuaj të bazës së të dhënave.
b. Zëvendësoni USERID dhe PASSWORD me informacionin e llogarisë së përdoruesit të administratorit të bazës së të dhënave.
c. Futni vlerën e afatit sipas nevojës. - Kliko Encrypt.
- Në fushën e vargut të lidhjes së koduar, kopjoni tekstin.
- Mbyll kutinë e dialogut.
- Në menynë API Test Kit, klikoni Connection > COM API Connection Tester.
- Në skedën Versioni aktual, ngjisni vargun e koduar të lidhjes në fushën e vargut të lidhjes.
- Në fushat LoginId dhe Password, futni ID-në e hyrjes dhe fjalëkalimin për llogarinë tuaj Changepoint.
- Në fushën Loglevel (0-8), specifikoni nivelin e informacionit të gabimit që do të kthehet në regjistrin e COM API file nëse rezultati i testit tregon një problem me lidhjen.
0 = Nuk ka prerje
1 = Objekti dhe metoda burimore
2 = Mesazh gabimi
3 = Parametrat e hyrjes
4 = Kthimet
5 = Paralajmërim
8 = Pika kontrolli
Parazgjedhja është 8. - Klikoni Lidhu.
Nëse lidhja ishte e suksesshme, një mesazh suksesi shfaqet në fushën Rezultati. Nëse lidhja dështoi, kontrolloni regjistrin e COM API file për gabime. Vendndodhja e paracaktuar e regjistrit file është APIAPIlogs.
Kontrollimi i versionit të komponentëve të instaluar API
Ju mund të përdorni mjetin e verifikimit të versionit për të marrë detaje rreth komponentëve të instaluar, duke përfshirë versionin e lëshimit dhe rrugën.
- Ekzekutoni CPVersionChecker.exe. Rruga e paracaktuar është: Komponentët APIAPI
- Klikoni Lexo.
Kontrollimi i versionit të Web Shërbimet API
- Nisni Internet Explorer nga serveri ku Web Shërbimet API është instaluar dhe shkruani adresën:
http://localhost.port/CPWeb.Service/WSLogin.asmx ku porti është numri i portit të websiti ku keni instaluar CPWebDrejtoria virtuale e shërbimit. - Në faqen WSLlogin, klikoni lidhjen GetVersion.
- Klikoni Invoke.
Testimi i Web Lidhja API e shërbimeve
- Nisni Internet Explorer nga serveri ku Web Shërbimet API është instaluar dhe shkruani adresën: http://localhost.port/CPWeb.Service/WSLogin.asmx ku porti është numri i portit të websiti ku keni instaluar CPWebDrejtoria virtuale e shërbimit.
- Në faqen WSLlogin klikoni lidhjen TestConnection.
- Klikoni Invoke. 4. Në rezultatet e testit:
- Nëse elementi është i rremë, lidhja e provës pati sukses.
- Nëse elementi është i vërtetë, lidhja e provës dështoi. Për më shumë
informacion mbi arsyet e dështimit, shih dhe elemente në rezultatet e testit dhe kontrolloni regjistrat e API-së. Rruga e paracaktuar për regjistrat e API është: APIAPIlogs
Vendosja e Web Shërbimet API në një server gjuhësor
- Për të vendosur pikën e ndryshimit Web Shërbimet API në një server gjuhësor, duhet të shtoni ose përditësoni tag në Web Shërbimet API web.konfigurim. Vendndodhja e paracaktuar e Web.konfigurim file është: APICP Web ShërbimetWeb.konfigurim
- Nëse tag ekziston tashmë, sigurohuni që të dyja atributet e kulturës dhe uiCulture janë "en-US".
- Nëse tag nuk ekziston tashmë, shtoni sa vijon , koment, dhe elementet për tëweb> nyja:web>
Opsionet e Visual Basic: Cakto strikte =” true” për të mos lejuar të gjitha konvertimet e tipit të të dhënave ku mund të ndodhë humbja e të dhënave. Cakto explicit=”true” për të detyruar deklarimin e të gjitha variablave. –> - Rinisni IIS.
Dokumentet / Burimet
 |
Changepoint API Software [pdfUdhëzuesi i instalimit API, Software, Software API |
