Giya sa Pag-instalar sa API
Giya sa Reperensya
Changepoint 2021
© 2021 Changepoint Canada ULC Tanang katungod gigahin. MGA KATUNGOD SA GOBYERNO sa US-Ang paggamit, pagdoble, o pagbutyag sa Gobyerno sa US gipailalom sa mga pagdili sama sa gitakda sa Changepoint Canada ULC nga kasabutan sa lisensya ug ingon nga gihatag sa DFARS 227.7202-1(a) ug 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, o FAR 52.227-14 (ALT III), kon angay. Kini nga produkto adunay kompidensyal nga kasayuran ug mga sekreto sa pamatigayon sa Changepoint Canada ULC. Gidid-an ang pagbutyag nga wala ang nauna nga sinulat nga pagtugot sa Changepoint Canada ULC. Ang paggamit niini nga produkto kay ubos sa mga termino ug kondisyon sa License Agreement sa user uban sa Changepoint Canada ULC. Ang dokumentasyon mahimo lamang nga kopyahon sa License alang sa internal nga paggamit. Ang sulod niini nga dokumento dili mahimong usbon, usbon o usbon nga walay klaro nga sinulat nga pagtugot sa Changepoint Canada ULC. Ang Changepoint Canada ULC mahimong magbag-o sa sulod nga gipiho dinhi bisan unsang orasa, adunay pahibalo o wala.
Pag-instalar sa Changepoint API
Mahitungod sa pag-instalar sa Changepoint API
Ang Changepoint API anaa isip usa ka COM API, usa ka serbisyo sa Windows Communication Foundation (WCF) ug, alang sa backward compatibility, isip usa ka Web Mga Serbisyo sa Pagpauswag (WSE) nga serbisyo. Para sa impormasyon bahin sa Changepoint API, tan-awa ang Changepoint API Reference. Para sa mga nota sa pag-upgrade, mga caveat ug nahibal-an nga mga isyu, tan-awa ang Release Notes sa mga folder sa team sa Changepoint.
Pag-upgrade sa Changepoint API
Kung nag-upgrade ka gikan sa miaging pagpagawas sa Changepoint, gamita ang Windows Control Panel aron i-uninstall ang miaging bersyon sa Changepoint API ug ang mga sangkap niini sa dili pa i-install kini nga bersyon.
Mga kinahanglanon sa Changepoint API
Kinahanglan nimo nga i-install ang Changepoint sa dili pa nimo i-install ang Changepoint API. Para sa mga kinahanglanon sa software, tan-awa ang Changepoint Software Compatibility Matrix, nga anaa sa 2021 Release Notes and Patches team folder sa Changepoint.
File mga kombensiyon sa dalan
Sa tibuok niini nga dokumento, ang mosunod nga mga kombensiyon gigamit alang sa komon nga mga agianan:
- Ang gamut nga agianan sa pag-instalar sa Changepoint.
Ang default nga agianan mao ang:
C: Programa Files (x86)ChangepointChangepoint - Ang gamut nga lokasyon alang sa komon nga Changepoint utilities, sama sa Login Settings utility.
Ang default nga agianan mao ang:
C: Programa Files (x86) Kasagaran FilesChangepointChangepoint
Pag-instalar sa Changepoint API
- Gikan sa Changepoint API media root directory, run setup.exe.
- Sunda ang mga prompt hangtud nga makita ang Select Features screen.
- Pilia ang mga bahin nga gusto nimong i-install, dayon i-klik ang Next.
- Pilia ang folder sa destinasyon sa API, default API, ug i-klik ang Next.
Mubo nga sulat: Ang Changepoint Login Settings utility na-install sa LoginSettings, bisan unsa pa ang destinasyon nga folder nga imong gitakda. - Kung gipili nimo ang Web Serbisyo API: a. Sa diha nga ang Pagpili
a Web Ang screen sa site makita, pilia ang a website aron idugang ang virtual nga direktoryo, ug dayon i-klik ang Next.
b. I-klik ang Sunod aron magpadayon. 6. Kung kompleto na ang pag-instalar sa API, i-klik ang Finish.
Pag-configure sa Changepoint API aron mahibal-an ang cache
Aron ma-configure ang Changepoint API nga mahimong nahibal-an sa cache, ilisan ang mga kantidad alang sa "cache. Password" ug "cache. Mga server" nga yawe sa CP Web Mga serbisyoWeb.config file uban sa mga mithi nga gigamit sa EnterpriseWeb.config file.
Makapahimo Web Mga Pagpauswag sa Serbisyo (WSE)
- I-edit ang Web.config file kay web serbisyo. Ang default nga lokasyon mao ang:
APICP Web Mga serbisyoWeb.config - Pangitaa ang tulo ka mga higayon sa mosunod nga linya sa komentaryo:
< !– Uncomment sa mosunod nga elemento kon ikaw naggamit Web Service Enhancements (WSE) API. Pagbilin og mga komentaryo kung naggamit sa mga serbisyo sa WCF ug wala mag-install Web Mga Pagpauswag sa Serbisyo (WSE) -> - I-uncomment ang elemento nga nagsunod sa matag instance sa comment line:
<pangalan sa seksyon = "microsoft.web.serbisyo2″ … >webMga serbisyo>web.mga serbisyo2>
Mubo nga sulat: AngwebMga serbisyo> elemento nga dili makomentaryo kay usa ka bata saweb>.
Pag-configure sa pag-log alang sa Web Serbisyo API
Kinahanglan nimong itakda ang log file agianan ug lebel sa log. Ang lebel sa log kay kumulative. Kay example, kung imong ipiho ang lebel 3, unya ang lebel 1, 2, ug 3 ma-log. Ang default nga lebel sa log mao ang 8.
- I-edit ang web serbisyo Web.config. Ang default nga lokasyon mao ang:
APICP Web Mga serbisyoWeb.config - Ibutang ang LogFileDalan. Ang default nga kantidad mao ang APIAPILogs. 3. Ibutang ang LogLevel. Ang balido nga mga kantidad mao ang:
0 = Walay logging
1 = Tinubdan nga butang ug pamaagi
2 = Mensahe sa sayup
3 = Mga parametro sa input
4 = Pagbalik
5 = Pasidaan
8 = Checkpoint
Pag-configure sa virtual nga direktoryo nga panghimatuud alang sa Web Serbisyo API
Kinahanglan nimong palihokon ang anonymous nga pag-access ug i-disable ang Integrated Windows authentication para sa CPWebSerbisyo virtual nga direktoryo sa Internet Information Services (IIS). Alang sa dugang nga kasayuran, tan-awa ang dokumentasyon sa Microsoft IIS.
Pag-configure sa mga setting sa koneksyon sa database alang sa Web Serbisyo API
Gamita ang Login Settings utility aron ma-encrypt ang database connection settings sa Web Serbisyo API Web.config file. Alang sa dugang nga impormasyon, pangitaa ang "Pag-configure sa Mga Setting sa Koneksyon sa Database" sa Giya sa Pag-instalar sa Changepoint.
Pag-configure sa panghimatuud alang sa Changepoint WCF Web Mga serbisyo
Mahimo nimong i-configure ang Application Authentication ug single sign-on (SSO) para sa Changepoint WCF Web Mga serbisyo.
Ang mosunod nga mga opsyon sa pagpatuman anaa gamit ang Secure Token Service (STS):
- SSO gamit ang ISAPI SSL opsyonal
- SSO gamit ang WS-Federation (ADFS 2.0) SSL gikinahanglan
Kung gikinahanglan ang SSL, ang script sa configuration nagsiguro nga kini gigamit.
Ang configuration scripts para sa ISAPI ug application authentication mahimong opsyonal nga makapahimo sa SSL.
Pag-configure sa pag-authenticate sa aplikasyon alang sa WCF Web Mga serbisyo
Ang default nga tipo sa panghimatuud alang sa Changepoint WCF Web Ang mga serbisyo mao ang pag-authenticate sa aplikasyon.
Gamita ang mga pamaagi niini nga seksyon sa:
- i-configure ang Changepoint WCF Web Mga serbisyo aron magamit ang pag-authenticate sa aplikasyon gamit ang SSL
- ibalik ang Changepoint WCF Web Mga serbisyo sa pag-authenticate sa aplikasyon pagkahuman gipatuman ang usa sa mga pagpatuman sa SSO
I-configure ang PowerShell
- Ablihi ang Windows PowerShell prompt.
- Usba ang polisiya sa pagpatuman:
Set-ExecutionPolicy Dili Restricted
Stage 1 Kolektaha ang mga parameter sa pag-configure
Tinoa ang mga kantidad alang sa mga parameter sa pagsumpo.
| Parameter | Deskripsyon |
| WebService_Path | Lokasyon sa Changepoint WCF Web Mga serbisyo web aplikasyon files. Default: \API\CP Web Mga serbisyo |
| Sertipiko sa Serbisyo_ Ngalan |
Ngalan sa sertipiko nga gamiton sa pag-authenticate sa serbisyo sa mga kliyente gamit ang Message security mode. Default: ang “CN=ChangepointAPICertificate” Ngalan sa Sertipiko. |
| nanginahanglan og HTTPS | Nagkinahanglan og HTTPS (Tinuod/Bakak) Default: Bakak. |
Stage 2 Ipatuman ang mga script sa pag-configure
Gamita ang mga kantidad alang sa mga parameter sa pag-configure aron mabag-o ang pagsumpo sa webmga site.
- Ablihi ang PowerShell prompt.
Mubo nga sulat: Kung ang imong server adunay User Account Control nga gipagana, kinahanglan nimo nga ablihan ang PowerShell prompt gamit ang taas nga pagtugot sa tagdumala. - Pagdala ngadto sa CP web direktoryo sa pag-configure sa serbisyo, default:
ConfigurationCPWebSerbisyo - Ipatuman ang ./Configuration_AppAuth.ps1
- Sunda ang mga aghat.
Pag-configure sa single sign-on (SSO) para sa WCF Web Mga serbisyo
I-configure ang PowerShell
- Ablihi ang Windows PowerShell prompt.
- Usba ang polisiya sa pagpatuman:
Set-ExecutionPolicy Dili Restricted
Pag-configure sa SSO gamit ang ISAPI para sa WCF Web Mga serbisyo
Stage 1 Kolektaha ang mga parameter sa pag-configure
Tinoa ang mga bili alang sa mosunod nga mga parameter sa pag-configure.
| Parameter | Deskripsyon |
| WebService_Path | Ang lokasyon sa Changepoint WCF Web Mga serbisyo web aplikasyon files. Default: \API\CP Web Mga serbisyo |
| nanginahanglan og HTTPS | Nagkinahanglan og HTTPS (Tinuod/Sayop). Default: Bakak. |
| Changepoint_RSA_ Cookie_Transform |
Ang ngalan sa sertipiko nga imong gigamit alang sa Cookie encryption. Default: ang “CN=ChangepointAPICertificate” Ngalan sa Sertipiko. |
| ServiceCertificate_Name | Pagsulod sa ngalan sa sertipiko nga gamiton sa pag-authenticate sa serbisyo sa mga kliyente gamit ang Message security mode. Default: ang “CN=ChangepointAPICertificate” Ngalan sa Sertipiko. |
| SigningCertificate_Name | Pagsulod sa ngalan sa sertipiko sa pagpirma. Kini ang ngalan sa sertipiko nga imong gigamit sa pagpirma sa mga mensahe. Default: ang “CN=ChangepointAPICertificate” Ngalan sa Sertipiko. |
| ISAPI_Mode | Ang ISAPI mode. Default: NT |
| ISAPI_Header | Ang header nga gigamit sa dihang ang ISAPI_Mode kay “HEADER”, pananglitanample, blangko. |
| ClaimType | Pagsulod sa SSO Claim Type. Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Ipatuman ang mga script sa pag-configure
- Ablihi ang PowerShell prompt.
Mubo nga sulat: Kung ang imong server adunay User Account Control nga gipagana, kinahanglan nimo nga ablihan ang PowerShell prompt gamit ang taas nga pagtugot sa tagdumala. - Pagdala ngadto sa CP web direktoryo sa pag-configure sa serbisyo, default:
ConfigurationCPWebSerbisyo - Ipatuman: ./Configuration_SSO_ISAPI.ps1
- Sunda ang mga aghat.
Pag-configure sa SSO gamit ang WS-Federation (ADFS 2.0) para sa WCF Web Mga serbisyo
Stage 1 Kolektaha ang mga parameter sa pag-configure
Tinoa ang mga kantidad alang sa mga parameter sa pagsumpo sa lamesa, sa ubos. Siguradoha nga ang ADFS_Server_URI naa sa Intranet zone sa browser sa end-user.
Mubo nga sulat: Pinaagi sa default, ang Changepoint gi-configure aron awtomatiko nga i-update ang mga yawe sa publiko nga gigamit sa pagpirma sa mga token sa seguridad pinaagi sa paggamit sa gipatik nga dokumento sa metadata sa federation. Sa ADFS kini mao ang:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Sa pipila ka mga kaso dili posible nga maabot ang ADFS server gikan sa Changepoint web server aron kinahanglan nimo nga mano-mano nga i-update ang configuration pagkahuman sa pagdagan sa script sa pag-configure. Para sa mga detalye, tan-awa ang “Manual nga pag-update sa mga public key” sa pahina 12.
| Parameter | Deskripsyon |
| WebService_Path | Lokasyon sa Changepoint WCF Web Mga serbisyo web aplikasyon files. Default: \API\CP Web Mga serbisyo |
| WebSerbisyo_URI | Domain identifier nga imong gigamit para sa Changepoint WCF Web Mga serbisyo. Kay example., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_ Cookie_Transform | Ngalan sa sertipiko nga imong gigamit alang sa Cookie encryption. Default: ang “CN=ChangepointApiCertificate” Ngalan sa Sertipiko. |
| ServiceCertificate_Name | Ngalan sa sertipiko nga gamiton sa pag-authenticate sa serbisyo sa mga kliyente gamit ang Message security mode. Default: ang "CN=ChangepointApiCertificate" Ngalan sa Sertipiko. |
| SigningCertificate_Name | Ngalan sa sertipiko nga imong gigamit sa pagpirma sa mga mensahe. Default: ang "CN=ChangepointApiCertificate" nga Ngalan sa Sertipiko gigamit. |
| ADFS_ FederationServiceName | Ngalan sa Serbisyo sa Federation. Aron makuha ang ngalan: Gikan sa ADFS server, Ilunsad ang ADFS 2.0 Management console. • Pilia ang ADFS 2.0 gikan sa wala nga menu. • Gikan sa Action pane pilia ang Edit Federation Service Properties. Ang Ngalan sa Serbisyo sa Federation naa sa General tab. |
| ClaimType | Tipo sa Pag-angkon sa SSO. Ang default mao ang: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Ipatuman ang mga script sa pag-configure
I-configure ang webmga site nga naggamit sa mga kantidad alang sa mga parameter sa pag-configure.
- Ablihi ang PowerShell prompt.
Mubo nga sulat: Kung ang imong server adunay User Account Control nga gipagana, kinahanglan nimo nga ablihan ang PowerShell prompt gamit ang taas nga pagtugot sa tagdumala. - Pagdala ngadto sa Changepoint web direktoryo sa pag-configure sa serbisyo, default: ConfigurationCPWebSerbisyo
- Ipatuman: ./Configuration_SSO_ADFS.ps1
- Sunda ang mga aghat.
Stage 3 Paghimo ug pagsalig sa partido
Paghimo sa Relying Party Trust sa ADFS 2.0 Console.
- Sa imong ADFS server, ilunsad ang ADFS 2.0 console.
- Pilia ang Aksyon > Add Relying Party Trust.
- I-klik ang Start.
- Pilia ang Import data bahin sa nagsalig nga partido nga gipatik online o sa usa ka lokal nga network.
- Pagsulod sa Federation metadata address, ug dayon i-klik ang Next, alang sa example:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Pagsulod ug Display name, eg Changepoint WCF API, ug i-klik ang Next, Next, Next, unya Close.
- Pagdugang og Lagda sa Pag-angkon alang sa naa sa ibabaw nga Changepoint Relying Party. Alang sa Changepoint, ang default nga ngalan sa lagda sa Claim mao ang "UPN".
- Mapa ang LDAP Attribute "User-Principal-Name" sa Outgoing Claim Type "* UPN" o "UPN".
Manwal nga pag-update sa mga yawe sa publiko
Aron makuha ang ADFS Server Token Signing Thumbprint
- Gikan sa ADFS server, Ilunsad ang ADFS 2.0 Management console.
- Pilia ang Serbisyo > Mga Sertipiko, ug i-double click ang Token-signing certificate.
- Pilia ang tab nga Mga Detalye.
- Pilia ang natad sa Thumbprint.
- Aron makuha ang kantidad sa thumbprint, kuhaa ang tanang mga luna lakip ang unang luna.
Aron ma-update ang Web.config file
- I-edit ang ADFS web.config. Ang default nga lokasyon mao ang:
EnterpriseRP-STS_ADFS - Ubos sa elemento, pangitaa ang ida:FederationMetadataLocation key ug hawanan ang bili niini:
- Ilalum , pangitaa ang elemento ug pulihan kini sa mosunod: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />
Pagsulay sa koneksyon sa COM API
- Pagdalagan ang API Test Kit. Ang default nga lokasyon mao ang:
APIAPI ComponentsApiTestKit.exe. - I-klik ang Connection String > Encrypter.
- Diha sa Plain Text Connections String field:
a. Ilisan ang SERVERNAME ug DATABASENAME sa imong database information.
b. Ilisan ang USERID ug PASSWORD sa imong database admin user account nga impormasyon.
c. Isulod ang timeout value kung gikinahanglan. - I-klik ang Encrypt.
- Sa natad sa Encrypted Connection String, kopyaha ang teksto.
- Isira ang dialog box.
- Sa menu sa API Test Kit, i-klik ang Connection > COM API Connection Tester.
- Sa tab nga Kasamtangang Bersyon, idikit ang na-encrypt nga koneksyon nga kuwerdas sa natad sa Connection String.
- Diha sa LoginId ug Password field, isulod ang login ID ug password para sa imong Changepoint account.
- Sa Loglevel (0-8) field, ipiho ang lebel sa impormasyon sa sayop nga ibalik sa COM API log file kung ang resulta sa pagsulay nagpakita og problema sa koneksyon.
0 = Walay logging
1 = Tinubdan nga butang ug pamaagi
2 = Mensahe sa sayup
3 = Mga parametro sa input
4 = Pagbalik
5 = Pasidaan
8 = Checkpoint
Ang default mao ang 8. - I-klik ang Sumpaysumpaya.
Kung malampuson ang koneksyon, usa ka mensahe sa kalampusan ang gipakita sa natad sa Resulta. Kung napakyas ang koneksyon, susiha ang COM API log file alang sa mga sayop. Ang default nga lokasyon sa log file mao ang APIAPILogs.
Pagsusi sa bersyon sa na-install nga mga sangkap sa API
Mahimo nimong gamiton ang utility checker nga bersyon aron makakuha og mga detalye bahin sa na-install nga mga sangkap, lakip ang bersyon sa pagpagawas ug agianan.
- Pagdalagan ang CPVersionChecker.exe. Ang default nga agianan mao ang: Mga sangkap sa APIAPI
- I-klik ang Basaha.
Pagsusi sa bersyon sa Web Serbisyo API
- Ilunsad ang Internet Explorer gikan sa server diin ang Web Gi-install ang Services API, ug isulod ang adres:
http://localhost.port/CPWeb.Service/WSLogin.asmx diin ang pantalan mao ang numero sa pantalan sa website diin imong gi-install ang CPWebSerbisyo virtual nga direktoryo. - Sa WSLogin nga panid, i-klik ang GetVersion link.
- I-klik ang Pag-imbitar.
Pagsulay sa Web Serbisyo API koneksyon
- Ilunsad ang Internet Explorer gikan sa server diin ang Web Gi-install ang Services API, ug isulod ang adres: http://localhost.port/CPWeb.Service/WSLogin.asmx diin ang pantalan mao ang numero sa pantalan sa website diin imong gi-install ang CPWebSerbisyo virtual nga direktoryo.
- Sa WSLogin nga panid i-klik ang TestConnection link.
- I-klik ang Pag-imbitar. 4. Sa mga resulta sa pagsulay:
- Kung sayop ang elemento, milampos ang koneksyon sa pagsulay.
- Kung ang elemento tinuod, ang pagsulay nga koneksyon napakyas. Alang sa dugang pa
impormasyon sa mga rason sa kapakyasan, tan-awa ang ug mga elemento sa mga resulta sa pagsulay, ug susihon ang mga log sa API. Ang default nga agianan sa API logs mao ang: APIAPILogs
Pagpahimutang sa Web Services API sa usa ka server sa pinulongan
- Aron i-deploy ang Changepoint Web Services API sa usa ka server sa pinulongan, kinahanglan nimong idugang o i-update ang tag sa Web Serbisyo API web.config. Ang default nga lokasyon sa Web.config file mao ang: APICP Web Mga serbisyoWeb.config
- Kung ang tag anaa na, siguroha nga ang kultura ug uiCulture nga mga hiyas kay "en-US."
- Kung ang tag wala na, idugang ang mosunod , komento, ug mga elemento saweb> node:web>
Mga kapilian sa Visual Basic: Itakda ang higpit = "tinuod" aron dili tugotan ang tanan nga mga pagbag-o sa tipo sa datos diin mahimong mahitabo ang pagkawala sa datos. Itakda ang klaro = "tinuod" aron mapugos ang deklarasyon sa tanan nga mga variable. –> - Pagsugod usab sa IIS.
Mga Dokumento / Mga Kapanguhaan
 |
Changepoint API Software [pdf] Giya sa Pag-instalar API, Software, API Software |
