Changepoint API Software Installation Guide

API Installation Guide
Phau ntawv qhia
Changepoint 2021

© 2021 Changepoint Canada ULC All rights reserved. US GOVERNMENT RIGHTS-Siv, luam tawm, lossis tshaj tawm los ntawm Tsoomfwv Meskas yuav raug txwv raws li tau teev tseg hauv Changepoint Canada ULC daim ntawv tso cai daim ntawv cog lus thiab raws li tau muab hauv DFARS 227.7202-1(a) thiab 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, los yog FAR 52.227-14 (ALT III), raws li muaj feem tau. Cov khoom no muaj cov ntaub ntawv tsis pub lwm tus paub thiab kev lag luam zais cia ntawm Changepoint Canada ULC. Kev tshaj tawm raug txwv tsis pub muaj kev tso cai sau ua ntej ntawm Changepoint Canada ULC. Kev siv cov khoom no yog ua raws li cov cai thiab cov cai ntawm tus neeg siv Daim Ntawv Pom Zoo Daim Ntawv Pom Zoo nrog Changepoint Canada ULC. Cov ntaub ntawv tsuas yog muab luam tawm los ntawm Tus Neeg Tso Cai rau kev siv sab hauv. Cov ntsiab lus ntawm daim ntawv no yuav tsis raug hloov pauv, hloov kho lossis hloov pauv yam tsis muaj kev pom zoo sau tseg ntawm Changepoint Canada ULC. Changepoint Canada ULC tuaj yeem hloov cov ntsiab lus tau teev tseg ntawm no txhua lub sijhawm, nrog lossis tsis ceeb toom.

Txhim kho Changepoint API

Txog kev txhim kho Changepoint API
Changepoint API yog muaj raws li COM API, qhov kev pabcuam Windows Kev Sib Txuas Lus (WCF) thiab, rau rov qab sib raug zoo, raws li ib tug Web Services Enhancements (WSE). Yog xav paub ntxiv txog Changepoint API, saib Changepoint API Reference . Rau kev hloov kho cov ntawv sau tseg, cov lus ceeb toom thiab cov teeb meem paub, saib Cov Ntawv Tshaj Tawm hauv pab pawg folders hauv Changepoint.
Txhim kho qhov Changepoint API
Yog tias koj tab tom hloov kho dua tshiab los ntawm qhov kev tso tawm dhau los ntawm Changepoint, siv Windows Control Vaj Huam Sib Luag kom tshem tawm cov version dhau los ntawm Changepoint API thiab nws cov khoom ua ntej txhim kho cov version no.
Changepoint API cov cai
Koj yuav tsum nruab Changepoint ua ntej koj nruab qhov Changepoint API. Rau cov kev xav tau software, saib Changepoint Software Compatibility Matrix, uas muaj nyob rau hauv 2021 Release Notes and Patches team folder in Changepoint.
File txoj kev cai
Thoob plaws hauv daim ntawv no, cov rooj sib tham hauv qab no yog siv rau txoj hauv kev:

• Txoj kev hauv paus ntawm Changepoint installation.
  Txoj kev default yog:
  C: Program Files (x86)ChangepointChangepoint
• Qhov chaw hauv paus rau cov khoom siv hloov pauv hloov pauv, xws li Login Settings utility.
  Txoj kev default yog:
  C: Program Files (x86) Common FilesChangepointChangepoint

Txhim kho Changepoint API

1. Los ntawm Changepoint API media root directory, khiav setup.exe.
2. Ua raws li cov lus qhia kom txog rau thaum Xaiv Cov Ntais npo tshwm.
3. Xaiv cov yam ntxwv uas koj xav nruab, ces nyem Next.
4. Xaiv lub API lo lus uas peb folder, default API, thiab nyem Next.
   Nco tseg: Lub Changepoint Login Settings utility yog ntsia rau hauv LoginSettings, tsis hais lub hom phiaj twg uas koj tau teev tseg.
5. Yog tias koj xaiv qhov Web Services API: a. Thaum Xaiv
   a Web Site screen tshwm, xaiv a website ntxiv cov npe virtual rau, thiab tom qab ntawd nyem Next.
   b. Nyem Next mus ntxiv. 6. Thaum lub installation ntawm API tiav, nyem Finish.

Configuring the Changepoint API kom paub txog cache
Txhawm rau teeb tsa Changepoint API kom paub txog cache, hloov qhov tseem ceeb rau "cache. Password" thiab "cache. Servers" cov yuam sij hauv CP Web Kev pabcuamWeb.config file nrog cov nqi siv hauv EnterpriseWeb.config file.
Ua kom tau Web Services Enhancements (WSE)

1. Kho cov Web.config file rau web kev pabcuam. Qhov chaw nyob yog:
   APICP Web Kev pabcuamWeb.config
2. Nrhiav peb qhov piv txwv ntawm kab lus hauv qab no:
   < !– Tsis hais cov ntsiab lus hauv qab no yog tias koj siv Web Service Enhancements (WSE) API. Tawm lus yog tias siv WCF cov kev pabcuam thiab tsis txhim kho Web Service Enhancements (WSE) ->
3. Uncomment lub ntsiab uas ua raws li txhua qhov piv txwv ntawm kab lus hais:
   <section name="microsoft.web.services2″…>webKev pab>web.kev pab 2>
   Nco tseg: CovwebCov kev pab> yam yuav tsum tau uncommented yog ib tug me nyuam ntawmweb>.

Configuring loging rau lub Web Services API
Koj yuav tsum teem lub log file txoj kev thiab lub log theem. Cov qib log yog cumulative. Rau example, yog tias koj teev qib 3, ces qib 1, 2, thiab 3 yog nkag. Tus txheej txheem log yog 8.

1. Kho cov web kev pabcuam Web.config. Qhov chaw nyob yog:
   APICP Web Kev pabcuamWeb.config
2. Teeb lub LogFileTxoj kev. Tus nqi pib yog APIAPILogs. 3. Teem lub LogLevel. Cov nqi siv tau yog:
   0 = Tsis muaj log
   1 = Cov khoom siv thiab cov txheej txheem
   2 = Cov lus yuam kev
   3 = Input parameters
   4 = Rov qab
   5 = Ceeb toom
   8 = Checkpoint

Configuring virtual directory authentication rau lub Web Services API
Koj yuav tsum ua kom tsis qhia npe nkag thiab lov tes taw Integrated Windows authentication rau CPWebKev pabcuam virtual directory hauv Internet Information Services (IIS). Yog xav paub ntxiv, saib cov ntaub ntawv Microsoft IIS.
Configuring database kev twb kev txuas chaw rau lub Web Services API
Siv lub Login Settings utility los encrypt cov database kev twb kev txuas chaw nyob rau hauv lub Web Services API Web.config file. Yog xav paub ntxiv, tshawb rau "Configuring Database Connection Settings" nyob rau hauv Phau Ntawv Qhia Kev Txhim Kho Hloov.
Configuring authentication rau Changepoint WCF Web Kev pabcuam
Koj tuaj yeem teeb tsa Daim Ntawv Thov Kev lees paub thiab ib qho kos npe rau (SSO) rau Changepoint WCF Web Kev pabcuam.
Cov kev xaiv hauv qab no muaj nyob rau hauv Kev Pabcuam Secure Token (STS):

• SSO siv ISAPI SSL xaiv tau
• SSO siv WS-Federation (ADFS 2.0) SSL xav tau

Yog tias SSL xav tau, cov ntawv teeb tsa ua kom ntseeg tau tias nws siv.
Cov ntawv teeb tsa rau ISAPI thiab daim ntawv thov kev lees paub tuaj yeem xaiv tau SSL.
Configuring application authentication rau WCF Web Kev pabcuam
Hom kev lees paub qhov tseeb rau Changepoint WCF Web Cov kev pabcuam yog daim ntawv thov kev lees paub.
Siv cov txheej txheem hauv ntu no rau:

• configure Changepoint WCF Web Cov kev pabcuam siv daim ntawv thov kev lees paub nrog SSL
• rov qab Changepoint WCF Web Kev pabcuam rau daim ntawv thov kev lees paub tom qab tau ua tiav ib qho ntawm SSO kev siv

Configure PowerShell

1. Qhib Windows PowerShell qhov hais kom ua.
2. Hloov txoj cai tswjfwm:
   Teem-ExecutionPolicy Unrestricted

Stage 1 Sau configuration parameters
Txiav txim siab qhov tseem ceeb rau cov kev teeb tsa.

Parameter	Kev piav qhia
WebService_Path	Qhov chaw ntawm Changepoint WCF Web Kev pabcuam web daim ntawv thov files. Default: \API\CP Web Kev pabcuam
ServiceCertificate_ Lub npe	Daim ntawv pov thawj lub npe uas yuav siv los txheeb xyuas qhov kev pabcuam rau cov neeg siv khoom siv Message kev ruaj ntseg hom. Default: "CN = ChangepointAPICertificate" Daim Ntawv Pov Thawj Lub Npe.
xav tau HTTPS	Yuav tsum muaj HTTPS (True/False) Default: False.

Stage 2 Ua cov ntawv teeb tsa
Siv qhov tseem ceeb rau cov kev teeb tsa tsis tau hloov kho qhov teeb tsa ntawm qhov webqhov chaw.

1.  Qhib PowerShell qhov hais kom ua.
   Nco tseg: Yog tias koj tus neeg rau zaub mov muaj Kev Tswj Tus Neeg Siv Khoom, koj yuav tsum qhib PowerShell qhov kev qhia uas siv cov neeg ua haujlwm siab tso cai.
2. Nkag mus rau CP web service configuration directory, default:
   ConfigurationCPWebKev pabcuam
3.  Ua ./Configuration_AppAuth.ps1
4. Ua raws li cov lus qhia.

Configuring single sign-on (SSO) rau WCF Web Kev pabcuam
Configure PowerShell

1. Qhib Windows PowerShell qhov hais kom ua.
2. Hloov txoj cai tswjfwm:
   Teem-ExecutionPolicy Unrestricted

Configuring SSO siv ISAPI rau WCF Web Kev pabcuam
Stage 1 Sau configuration parameters
Txiav txim siab qhov tseem ceeb rau cov kev teeb tsa hauv qab no.

Parameter	Kev piav qhia
WebService_Path	Qhov chaw ntawm Changepoint WCF Web Kev pabcuam web daim ntawv thov files. Default: \API\CP Web Kev pabcuam
xav tau HTTPS	Yuav tsum muaj HTTPS (True/False). Default: False.
Changepoint_RSA_ Cookie_Transform	Lub npe ntawm daim ntawv pov thawj uas koj siv rau Cookie encryption. Default: "CN = ChangepointAPICertificate" Daim Ntawv Pov Thawj Lub Npe.
ServiceCertificate_Npe	Nkag mus rau daim ntawv pov thawj lub npe uas yuav siv los txheeb xyuas qhov kev pabcuam rau cov neeg siv khoom siv Message kev ruaj ntseg hom. Default: "CN = ChangepointAPICertificate" Daim Ntawv Pov Thawj Lub Npe.
Kos npeCertificate_Npe	Sau lub npe kos npe rau daim ntawv pov thawj. Nov yog lub npe ntawm daim ntawv pov thawj uas koj siv rau kos npe cov lus. Default: "CN = ChangepointAPICertificate" Daim Ntawv Pov Thawj Lub Npe.
ISAPI_Mode	ISAPI hom. Default: NT
ISAPI_Header	Lub header siv thaum ISAPI_Mode yog "HEADER", piv txwv liample ,loj.
Hom kev thov	Nkag mus rau SSO Claim Type. Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ua cov ntawv teeb tsa

1. Qhib PowerShell qhov hais kom ua.
   Nco tseg: Yog tias koj tus neeg rau zaub mov muaj Kev Tswj Tus Neeg Siv Khoom, koj yuav tsum qhib PowerShell qhov kev qhia uas siv cov neeg ua haujlwm siab tso cai.
2. Nkag mus rau CP web service configuration directory, default:
   ConfigurationCPWebKev pabcuam
3. Execute: ./Configuration_SSO_ISAPI.ps1
4. Ua raws li cov lus qhia.

Configuring SSO siv WS-Federation (ADFS 2.0) rau WCF Web Kev pabcuam
Stage 1 Sau configuration parameters
Txiav txim siab qhov tseem ceeb rau cov kev teeb tsa tsis nyob hauv lub rooj, hauv qab no. Xyuas kom meej tias ADFS_Server_URI yog nyob rau thaj tsam Intranet ntawm tus neeg siv kawg browser.
Nco tseg: Los ntawm lub neej ntawd, Changepoint tau teeb tsa kom hloov kho cov yuam sij pej xeem uas siv los kos npe rau kev ruaj ntseg tokens los ntawm kev siv cov ntaub ntawv luam tawm ntawm tsoomfwv cov metadata. Hauv ADFS qhov no yog:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Qee zaum nws yuav tsis tuaj yeem ncav cuag ADFS server los ntawm Changepoint web neeg rau zaub mov yog li koj yuav tau manually hloov kho cov configuration tom qab khiav lub configuration tsab ntawv. Yog xav paub meej, saib "Kev hloov kho cov yuam sij pej xeem" ntawm nplooj ntawv 12.

Parameter	Kev piav qhia
WebService_Path	Qhov chaw ntawm Changepoint WCF Web Kev pabcuam web daim ntawv thov files. Default: \API\CP Web Kev pabcuam
WebService_URI	Domain identifier uas koj siv rau Changepoint WCF Web Kev pabcuam. Rau example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Lub npe ntawm daim ntawv pov thawj uas koj siv rau Cookie encryption. Default: "CN = ChangepointApiCertificate" Daim Ntawv Pov Thawj Lub Npe.
ServiceCertificate_Npe	Daim ntawv pov thawj lub npe uas yuav siv los txheeb xyuas qhov kev pabcuam rau cov neeg siv khoom siv Message kev ruaj ntseg hom. Default: "CN = ChangepointApiCertificate" Daim Ntawv Pov Thawj Lub Npe.
Kos npeCertificate_Npe	Lub npe ntawm daim ntawv pov thawj uas koj siv rau kos npe cov lus. Default: "CN = ChangepointApiCertificate" Daim ntawv pov thawj lub npe yog siv.
ADFS_ FederationServiceName	Federation Service Lub npe. Kom tau txais lub npe: Los ntawm ADFS server, Launch ADFS 2.0 Management console. • Xaiv ADFS 2.0 los ntawm cov ntawv qhia zaub mov sab laug. •Los ntawm Action pane xaiv Kho kom raug Federation Service Properties. Lub npe Federation Service yog nyob rau ntawm General tab.
Hom kev thov	SSO Claim Type. Lub neej ntawd yog: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ua cov ntawv teeb tsa
Configure lub webcov chaw siv qhov tseem ceeb rau cov kev teeb tsa tsis raug.

1. Qhib PowerShell qhov hais kom ua.
   Nco tseg: Yog tias koj tus neeg rau zaub mov muaj Kev Tswj Tus Neeg Siv Khoom, koj yuav tsum qhib PowerShell qhov kev qhia uas siv cov neeg ua haujlwm siab tso cai.
2. Coj mus rhaub rau Hloov Chaw web service configuration directory, default: ConfigurationCPWebKev pabcuam
3.  Execute: ./Configuration_SSO_ADFS.ps1
4. Ua raws li cov lus qhia.

Stage 3 Tsim kev cia siab rau tog neeg
Tsim Lub Koom Haum Kev Ntseeg hauv ADFS 2.0 Console.

1. Ntawm koj lub ADFS server, qhib ADFS 2.0 console.
2. Xaiv Qhov Kev Ua> Ntxiv Relying Party Trust.
3. Nyem Pib.
4. Xaiv Ntshuam cov ntaub ntawv hais txog cov neeg tso siab tso tawm hauv online lossis hauv lub network hauv zos.
5. Nkag mus rau Federation metadata chaw nyob, thiab tom qab ntawd nyem Next, piv txwv liample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Sau lub npe zaub, piv txwv li Changepoint WCF API, thiab nyem Next, Next, Next, ces Kaw.
7. Ntxiv Txoj Cai Thov Kev Pab rau saum toj no Changepoint Relying Party. Rau Changepoint, lub npe hu ua "UPN".
8. Daim ntawv qhia LDAP Tus cwj pwm "User-Principal-Npe" rau hom kev thov tawm "* UPN" lossis "UPN".

Hloov kho cov yuam sij pej xeem manually
Yuav kom tau txais ADFS Server Token Signing Thumbprint

1. Los ntawm ADFS server, Launch ADFS 2.0 Management console.
2. Xaiv Cov Kev Pabcuam> Daim Ntawv Pov Thawj, thiab nyem ob npaug rau daim ntawv pov thawj Token-kos npe.
3. Xaiv lub Details tab.
4. Xaiv qhov Thumbprint teb.
5. Txhawm rau kom tau txais tus ntiv tes xoo, tshem tawm txhua qhov chaw nrog rau thawj qhov chaw.

Txhawm rau hloov kho cov Web.config file

1. Kho cov ADFS web.config. Qhov chaw nyob yog:
   EnterpriseRP-STS_ADFS
2. Hauv qab element, nrhiav ida:FederationMetadataLocation key thiab tshem nws tus nqi:
   
3. Hauv qab , nrhiav cov element thiab hloov nws nrog cov hauv qab no: https://ADFS_Federation.ServiceName/adfs/services/trust«>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Kev ntsuam xyuas COM API txuas

1. Khiav API Test Kit. Qhov chaw nyob yog:
   APIAPI ComponentsApiTestKit.exe.
2. Nyem Connection String> Encrypter.
3. Hauv Plain Text Connections String teb:
   a. Hloov SERVERNAME thiab DATABASENAME nrog koj cov ntaub ntawv database.
   b. Hloov USERID thiab PASSWORD nrog koj cov ntaub ntawv database admin user account information.
   c. Sau tus nqi sijhawm raws li xav tau.
4. Nyem Encrypt.
5. Hauv Encrypted Connection String teb, luam cov ntawv.
6. Kaw lub dialog box.
7. Ntawm API Test Kit ntawv qhia zaub mov, nyem Txuas> COM API Connection Tester.
8. Nyob rau hauv Tam sim no Version tab, muab tshuaj txhuam encrypted kev twb kev txuas txoj hlua rau hauv Connection String teb.
9. Hauv LoginId thiab Password teb, nkag mus rau tus ID nkag mus thiab lo lus zais rau koj tus account Changepoint.
10. Hauv Loglevel (0-8) teb, qhia txog qib ntawm cov ntaub ntawv yuam kev kom xa rov qab rau hauv COM API log file yog tias qhov ntsuas tau pom tias muaj teeb meem nrog kev sib txuas.
    0 = Tsis muaj log
    1 = Cov khoom siv thiab cov txheej txheem
    2 = Cov lus yuam kev
    3 = Input parameters
    4 = Rov qab
    5 = Ceeb toom
    8 = Checkpoint
    Lub neej ntawd yog 8.
11. Nyem Txuas.
    Yog tias qhov kev sib txuas tau ua tiav, cov lus ua tiav tau tshwm sim hauv qhov tshwm sim. Yog tias qhov kev sib txuas ua tsis tiav, kos lub COM API log file rau qhov yuam kev. Qhov chaw nyob ntawm lub log file yog APIAPILogs.

Tshawb xyuas cov version ntawm cov khoom API ntsia
Koj tuaj yeem siv cov khoom siv ntsuas ntsuas ntsuas kom tau txais cov ntsiab lus hais txog cov khoom nruab, suav nrog kev tso tawm version thiab txoj hauv kev.

1. Khiav CPVersionChecker.exe. Txoj kev default yog: APIAPI Cheebtsam
2. Nyem Nyeem.

Xyuas lub version ntawm lub Web Services API

1. Tua tawm Internet Explorer los ntawm lub server qhov twg Web Cov Kev Pabcuam API tau teeb tsa, thiab nkag mus rau qhov chaw nyob:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  qhov chaw nres nkoj yog tus lej chaw nres nkoj ntawm tus webqhov chaw uas koj tau nruab CPWebKev pabcuam virtual directory.
2. Ntawm nplooj ntawv WLogin, nyem qhov txuas GetVersion.
3. Nyem Invoke.

Kuaj cov Web Kev sib txuas API

1. Tua tawm Internet Explorer los ntawm lub server qhov twg Web Cov Kev Pabcuam API tau teeb tsa, thiab nkag mus rau qhov chaw nyob: http://localhost.port/CPWeb.Service/WSLogin.asmx  qhov chaw nres nkoj yog tus lej chaw nres nkoj ntawm tus webqhov chaw uas koj tau nruab CPWebKev pabcuam virtual directory.
2. Ntawm nplooj ntawv WLogin nyem qhov TestConnection txuas.
3. Nyem Invoke. 4. Nyob rau hauv qhov kev ntsuam xyuas:

• Yog lub ntsiab tsis muaj tseeb, qhov kev sim kev sib txuas ua tiav.
• Yog lub ntsiab lus muaj tseeb, qhov kev xeem sib txuas ua tsis tiav. Yog xav paub ntxiv
  cov ntaub ntawv ntawm cov laj thawj rau qhov ua tsis tiav, saib lub thiab cov ntsiab lus hauv cov txiaj ntsig kev xeem, thiab tshawb xyuas cov ntaub ntawv API. Lub neej ntawd txoj kev mus rau API cav yog: APIAPILogs

Kev teeb tsa lub Web Cov kev pabcuam API ntawm lub server hom lus

1. Txhawm rau siv lub Changepoint Web Kev Pabcuam API ntawm cov lus server, koj yuav tsum ntxiv lossis hloov kho cov tag hauv Web Services API web.config. Lub neej ntawd qhov chaw ntawm lub Web.config file yog: APICP Web Kev pabcuamWeb.config
2. Yog tias tag twb muaj lawm, xyuas kom meej tias ob qho tib si kab lis kev cai thiab uiCulture cwj pwm yog "en-US."
3. Yog tias tag tsis tau muaj, ntxiv cov hauv qab no , comment, thiab cov ntsiab lus rau covweb> node:web>
   Kev xaiv Visual Basic: Teem nruj = "muaj tseeb" kom tsis pub txhua yam ntaub ntawv hloov pauv uas cov ntaub ntawv poob tuaj yeem tshwm sim. Teem meej = "true" kom yuam kev tshaj tawm ntawm txhua qhov sib txawv. ->
4. Restart IIS.