Gid Enstalasyon API
Gid referans
Chanjman 2021

© 2021 Changepoint Canada ULC Tout dwa rezève. DWA GOUVÈNMAN AMERIKEN yo-Itilize, kopi, oswa divilgasyon pa Gouvènman Ameriken an sijè a restriksyon jan sa tabli nan akò lisans Changepoint Canada ULC a ak jan sa di nan DFARS 227.7202-1(a) ak 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, oswa FAR 52.227-14 (ALT III), jan sa aplikab. Pwodwi sa a gen enfòmasyon konfidansyèl ak sekrè komès Changepoint Canada ULC. Divilgasyon entèdi san otorizasyon alekri anvan Changepoint Canada ULC. Sèvi ak pwodui sa a sijè a tèm ak kondisyon Akò lisans itilizatè a ak Changepoint Canada ULC. Dokimantasyon ka repwodui sèlman pa Lisansye pou itilizasyon entèn. Kontni dokiman sa a pa ka chanje, modifye oswa chanje san konsantman alekri eksprime Changepoint Canada ULC. Changepoint Canada ULC ka chanje kontni ki espesifye nan nenpòt ki lè, avèk oswa san avètisman.

Enstale API a Changepoint

Konsènan enstale API a Changepoint
API Changepoint la disponib kòm yon API COM, yon sèvis Windows Communication Foundation (WCF) epi, pou konpatibilite bak, kòm yon Web Sèvis Amelyorasyon Sèvis (WSE). Pou enfòmasyon sou API Changepoint, gade Referans API Changepoint. Pou nòt ajou, opozisyon ak pwoblèm li te ye, gade Nòt yo Release nan dosye ekip nan Changepoint.
Amelyore API a Changepoint
Si w ap amelyore soti nan yon vèsyon anvan Changepoint, sèvi ak Windows Kontwòl Panel pou dezenstale vèsyon anvan API Changepoint la ak konpozan li yo anvan ou enstale vèsyon sa a.
Kondisyon API Changepoint
Ou dwe enstale Changepoint anvan ou enstale API a Changepoint. Pou egzijans lojisyèl, gade Matris konpatibilite lojisyèl Changepoint, ki disponib nan katab ekip la Release Notes and Patchs 2021 nan Changepoint.
File konvansyon chemen yo
Pandan tout dokiman sa a, yo itilize konvansyon sa yo pou chemen komen:

• Chemen rasin enstalasyon Changepoint la.
  Chemen default la se:
  C: Pwogram Files (x86)ChangepointChangepoint
• Kote rasin pou sèvis piblik komen Changepoint, tankou sèvis piblik Anviwònman Konekte a.
  Chemen default la se:
  C: Pwogram Files (x86) Komen FilesChangepointChangepoint

Enstale API a Changepoint

1. Soti nan anyè rasin medya Changepoint API, kouri setup.exe.
2. Swiv envit yo jiskaske ekran Chwazi karakteristik yo parèt.
3. Chwazi karakteristik ou vle enstale yo, epi klike sou Next.
4. Chwazi katab destinasyon API a, default API, epi klike sou Next.
   Nòt: Se sèvis piblik Changepoint Login Settings enstale nan LoginSettings, kèlkeswa katab destinasyon ou presize.
5. Si ou chwazi a Web Sèvis API: a. Lè Chwazi a
   a Web Ekran sit parèt, chwazi yon websit pou ajoute anyè vityèl la, epi klike sou Next.
   b. Klike sou Next pou kontinye. 6. Lè enstalasyon API a fini, klike sou Fini.

Konfigirasyon API Changepoint pou kachèt okouran
Pou konfigirasyon API Changepoint pou kachèt-konsyan, ranplase valè yo pou "kachèt la. Modpas" ak "kachèt. Sèvè” kle nan CP la Web SèvisWeb.config file ak valè yo itilize nan Enterprise laWeb.config file.
Pèmèt Web Amelyorasyon Sèvis (WSE)

1. Edit la Web.config file pou web sèvis yo. Kote defo a se:
   APICP Web SèvisWeb.config
2. Jwenn twa egzanp liy kòmantè sa yo:
   < !– Dekomantè eleman sa a si w ap itilize Web Amelyorasyon Sèvis (WSE) API. Kite kòmantè si w ap itilize sèvis WCF epi yo pa enstale Web Amelyorasyon Sèvis (WSE) –>
3. Dekomantè eleman ki swiv chak egzanp liy kòmantè a:
   <section name=”microsoft.web.services2″ … >webSèvis>web.sèvis2>
   Nòt: LawebSèvis> eleman yo dwe uncommented se yon timoun nanweb>.

Konfigirasyon antre pou la Web Sèvis API
Ou dwe mete boutèy demi lit la file chemen ak nivo boutèy demi lit. Nivo log yo kimilatif. Pou egzanpample, si ou presize nivo 3, Lè sa a, nivo 1, 2, ak 3 yo konekte. Nivo log default se 8.

1. Edit la web sèvis yo Web.config. Kote defo a se:
   APICP Web SèvisWeb.config
2. Mete Log laFileChemen. Valè default la se APIAPILogs. 3. Mete LogLevel la. Valè yo valab yo se:
   0 = Pa gen antre
   1 = Sous objè ak metòd
   2 = Mesaj erè
   3 = Paramèt Antre
   4 = Retounen
   5 = Avètisman
   8 = Pwen kontwòl

Konfigirasyon otantifikasyon anyè vityèl pou la Web Sèvis API
Ou dwe pèmèt aksè anonim epi enfim otantifikasyon entegre Windows pou CP aWebSèvis anyè vityèl nan Sèvis Enfòmasyon Entènèt (IIS). Pou plis enfòmasyon, gade dokiman Microsoft IIS la.
Konfigirasyon paramèt koneksyon baz done a Web Sèvis API
Sèvi ak sèvis piblik Anviwònman Login pou ankripte paramèt koneksyon baz done yo nan Web Sèvis API Web.config file. Pou plis enfòmasyon, chèche "Konfigirasyon Anviwònman Koneksyon Baz done" nan Gid Enstalasyon Changepoint la.
Konfigirasyon otantifikasyon pou Changepoint WCF Web Sèvis
Ou ka konfigirasyon Otantifikasyon Aplikasyon ak yon sèl sign-on (SSO) pou Changepoint WCF Web Sèvis.
Opsyon aplikasyon sa yo disponib lè l sèvi avèk Secure Token Service (STS):

• SSO lè l sèvi avèk ISAPI SSL si ou vle
• SSO lè l sèvi avèk WS-Federation (ADFS 2.0) SSL obligatwa

Si yo mande SSL, script konfigirasyon an asire ke li itilize.
Scripts konfigirasyon yo pou ISAPI ak otantifikasyon aplikasyon yo ka opsyonèlman pèmèt SSL.
Konfigirasyon otantifikasyon aplikasyon pou WCF Web Sèvis
Kalite otantifikasyon default pou Changepoint WCF Web Sèvis se otantifikasyon aplikasyon an.
Sèvi ak pwosedi ki nan seksyon sa a pou:

• konfigirasyon Changepoint WCF Web Sèvis pou itilize otantifikasyon aplikasyon ak SSL
• retounen Changepoint WCF Web Sèvis otantifikasyon aplikasyon apre yo fin aplike youn nan aplikasyon SSO yo

Konfigirasyon PowerShell

1. Louvri yon èd Windows PowerShell.
2. Modifye politik ekzekisyon an:
   Set-ExecutionPolicy San restriksyon

Stage 1 Kolekte paramèt konfigirasyon yo
Detèmine valè yo pou paramèt konfigirasyon yo.

Paramèt	Deskripsyon
WebService_Path	Kote WCF Changepoint la Web Sèvis web aplikasyon files. Default: \API\CP Web Sèvis
Sètifika Sèvis_ Non	Non sètifika yo pral itilize pou otantifye sèvis la bay kliyan lè l sèvi avèk mòd sekirite mesaj. Default: Non Sètifika "CN=ChangepointAPICertificate".
mande HTTPS	Mande HTTPS (vre/fo) Default: Fo.

Stage 2 Egzekite scripts konfigirasyon yo
Sèvi ak valè yo pou paramèt konfigirasyon yo modifye konfigirasyon an nan websit.

1.  Louvri yon èd memwa PowerShell.
   Nòt: Si sèvè ou a gen kontwòl kont itilizatè aktive, ou dwe louvri èd memwa PowerShell la lè l sèvi avèk otorizasyon administratè ki wo.
2. Navige nan CP la web anyè konfigirasyon sèvis, default:
   KonfigirasyonCPWebSèvis
3.  Egzekite ./Configuration_AppAuth.ps1
4. Swiv envit yo.

Konfigirasyon yon sèl sign-on (SSO) pou WCF Web Sèvis
Konfigirasyon PowerShell

1. Louvri yon èd Windows PowerShell.
2. Modifye politik ekzekisyon an:
   Set-ExecutionPolicy San restriksyon

Konfigirasyon SSO lè l sèvi avèk ISAPI pou WCF Web Sèvis
Stage 1 Kolekte paramèt konfigirasyon yo
Detèmine valè yo pou paramèt konfigirasyon sa yo.

Paramèt	Deskripsyon
WebService_Path	Kote WCF Changepoint la Web Sèvis web aplikasyon files. Default: \API\CP Web Sèvis
mande HTTPS	Mande HTTPS (Vre/Fo). Default: Fo.
Changepoint_RSA_ Cookie_Transform	Non sètifika ou itilize pou chifreman Cookie. Default: Non Sètifika "CN=ChangepointAPICertificate".
ServiceCertificate_Name	Antre non sètifika a ki pral itilize pou otantifye sèvis la bay kliyan lè l sèvi avèk mòd sekirite mesaj. Default: Non Sètifika "CN=ChangepointAPICertificate".
SigningCertificate_Name	Antre non sètifika siyen an. Sa a se non sètifika ou itilize pou siyen mesaj yo. Default: Non Sètifika "CN=ChangepointAPICertificate".
ISAPI_Mode	Mòd ISAPI a. Default: NT
ISAPI_Header	Tèt la itilize lè ISAPI_Mode se "HEADER", pou egzanpample, vid.
ClaimType	Antre Kalite Reklamasyon SSO. Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Egzekite scripts konfigirasyon yo

1. Louvri yon èd memwa PowerShell.
   Nòt: Si sèvè ou a gen kontwòl kont itilizatè aktive, ou dwe louvri èd memwa PowerShell la lè l sèvi avèk otorizasyon administratè ki wo.
2. Navige nan CP la web anyè konfigirasyon sèvis, default:
   KonfigirasyonCPWebSèvis
3. Egzekite: ./Configuration_SSO_ISAPI.ps1
4. Swiv envit yo.

Konfigirasyon SSO lè l sèvi avèk WS-Federation (ADFS 2.0) pou WCF Web Sèvis
Stage 1 Kolekte paramèt konfigirasyon yo
Detèmine valè yo pou paramèt konfigirasyon yo nan tablo ki anba a. Asire w ke ADFS_Server_URI a nan zòn Intranet navigatè itilizatè final la.
Nòt: Pa defo, Changepoint configuré pou otomatikman aktyalize kle piblik yo ki itilize pou siyen siy sekirite lè l sèvi avèk dokiman metadata federasyon an pibliye. Nan ADFS sa a se:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Nan kèk ka li ka pa posib yo rive jwenn sèvè ADFS la soti nan Changepoint la web sèvè konsa w ap oblije mete ajou konfigirasyon an manyèlman apre w fin kouri script konfigirasyon an. Pou plis detay, gade "Mete ajou kle piblik yo manyèlman" nan paj 12.

Paramèt	Deskripsyon
WebService_Path	Kote WCF Changepoint la Web Sèvis web aplikasyon files. Default: \API\CP Web Sèvis
WebSèvis_URI	Idantifyan domèn ke ou itilize pou Changepoint WCF Web Sèvis. Pou egzanpample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_Cook_Transform	Non sètifika ou itilize pou chifreman Cookie. Default: Non Sètifika "CN=ChangepointApiCertificate".
ServiceCertificate_Name	Non sètifika yo pral itilize pou otantifye sèvis la bay kliyan lè l sèvi avèk mòd sekirite mesaj. Default: Non Sètifika "CN=ChangepointApiCertificate".
SigningCertificate_Name	Non sètifika ou itilize pou siyen mesaj yo. Default: Yo itilize Non Sètifika "CN=ChangepointApiCertificate".
ADFS_ FederationServiceName	Non Sèvis Federasyon an. Pou jwenn non an: Soti nan sèvè ADFS la, Lanse ADFS 2.0 Konsole Jesyon. • Chwazi ADFS 2.0 nan meni gòch la. • Nan volet Aksyon an, chwazi Edit Federation Service Properties. Non Sèvis Federasyon an sou tab Jeneral la.
ClaimType	Kalite reklamasyon SSO. Defo a se: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Egzekite scripts konfigirasyon yo
Konfigirasyon an websit itilize valè yo pou paramèt konfigirasyon yo.

1. Louvri yon èd memwa PowerShell.
   Nòt: Si sèvè ou a gen kontwòl kont itilizatè aktive, ou dwe louvri èd memwa PowerShell la lè l sèvi avèk otorizasyon administratè ki wo.
2. Navige nan Changepoint la web anyè konfigirasyon sèvis, default: KonfigirasyonCPWebSèvis
3.  Egzekite: ./Configuration_SSO_ADFS.ps1
4. Swiv envit yo.

Stage 3 Kreye konfyans nan pati ki fè konfyans
Kreye konfyans nan Pati Relying nan ADFS 2.0 Konsole.

1. Sou sèvè ADFS ou a, lanse konsole ADFS 2.0 la.
2. Chwazi Aksyon > Add Relying Party Trust.
3. Klike sou Kòmanse.
4. Chwazi Enpòte done sou pati ki konte a pibliye sou entènèt oswa sou yon rezo lokal.
5. Antre adrès metadata Federasyon an, epi klike sou Next, pou egzanpample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Antre yon Non Display, pa egzanp Changepoint WCF API, epi klike sou Next, Next, Next, Lè sa a, Fèmen.
7. Ajoute yon Règ Reklamasyon pou Pati Relying Point Changepoint ki anwo a. Pou Changepoint, non règ Reklamasyon default la se "UPN".
8. Map atribi LDAP “User-Principal-Name” pou Kalite Reklamasyon Sortan “* UPN” oswa “UPN”.

Manyèlman mete ajou kle piblik yo
Pou jwenn anprent pou siyen sèvè ADFS la

1. Soti nan sèvè ADFS la, Lanse ADFS 2.0 Konsole Jesyon.
2. Chwazi Sèvis > Sètifika, epi double-klike sou sètifika siyen siy la.
3. Chwazi tab la Detay.
4. Chwazi jaden anprent.
5. Pou jwenn valè anprent dwèt pous la, retire tout espas ki gen ladan premye espas la.

Pou mete ajou la Web.config file

1. Edit ADFS la web.config. Kote defo a se:
   EnterpriseRP-STS_ADFS
2. Anba a eleman, jwenn kle ida:FederationMetadataLocation la epi netwaye valè li:
   
3. Anba , jwenn la eleman epi ranplase li ak bagay sa yo: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

Tès koneksyon COM API a

1. Kouri Twous Tès API a. Kote defo a se:
   APIAPI ComponentsApiTestKit.exe.
2. Klike sou Chaîne koneksyon > Encrypter.
3. Nan jaden Plain Text Connections String:
   a. Ranplase SERVERNAME ak DATABASENAME ak enfòmasyon baz done w la.
   b. Ranplase ID Itilizatè ak PASSWORD ak enfòmasyon kont itilizatè baz done ou.
   c. Antre valè timeout la jan sa nesesè.
4. Klike sou ankripte.
5. Nan jaden an Chiffre Koneksyon Chèn, kopye tèks la.
6. Fèmen bwat dyalòg la.
7. Nan meni API Test Kit, klike sou Koneksyon > COM API Connection Tester.
8. Nan onglet Vèsyon aktyèl la, kole kòd koneksyon an chiffres nan jaden Connection String.
9. Nan jaden LoginId ak Modpas, antre ID login ak modpas pou kont Changepoint ou a.
10. Nan jaden Loglevel (0-8), presize nivo enfòmasyon erè yo dwe retounen nan jounal COM API. file si rezilta tès la montre yon pwoblèm ak koneksyon an.
    0 = Pa gen antre
    1 = Sous objè ak metòd
    2 = Mesaj erè
    3 = Paramèt Antre
    4 = Retounen
    5 = Avètisman
    8 = Pwen kontwòl
    Defo a se 8.
11. Klike sou Konekte.
    Si koneksyon an te reyisi, yon mesaj siksè parèt nan jaden an Rezilta. Si koneksyon an echwe, tcheke jounal COM API a file pou erè. Kote defo nan boutèy demi lit la file se APIAPILogs.

Tcheke vèsyon an nan konpozan API enstale
Ou ka sèvi ak sèvis piblik la chèk vèsyon pou jwenn detay sou eleman yo enstale, ki gen ladan vèsyon an lage ak chemen.

1. Kouri CPVersionChecker.exe. Chemen default la se: Konpozan APIAPI
2. Klike sou Li.

Tcheke vèsyon an nan Web Sèvis API

1. Lanse Internet Explorer soti nan sèvè a kote a Web Sèvis API enstale, epi antre adrès la:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  kote pò se nimewo pò a websit kote ou enstale CP aWebSèvis anyè vityèl.
2. Sou paj WSLogin, klike sou lyen GetVersion.
3. Klike sou Envoke.

Tès la Web Sèvis koneksyon API

1. Lanse Internet Explorer soti nan sèvè a kote a Web Sèvis API enstale, epi antre adrès la: http://localhost.port/CPWeb.Service/WSLogin.asmx  kote pò se nimewo pò a websit kote ou enstale CP aWebSèvis anyè vityèl.
2. Sou paj WSLogin la klike sou lyen TestConnection.
3. Klike sou Envoke. 4. Nan rezilta tès yo:

• Si eleman se fo, koneksyon tès la reyisi.
• Si eleman se vre, koneksyon tès la echwe. Pou plis
  enfòmasyon sou rezon ki fè echèk la, gade nan epi eleman nan rezilta tès yo, epi tcheke mòso bwa API yo. Chemen default nan mòso bwa API yo se: APIAPILogs

Mete kanpe la Web Sèvis API sou yon sèvè lang

1. Pou deplwaye Changepoint la Web Sèvis API sou yon sèvè lang, ou dwe ajoute oswa mete ajou tag nan la Web Sèvis API web.config. Kote defo a nan Web.config file se: APICP Web SèvisWeb.config
2. Si la tag deja egziste, asire ke tou de atribi kilti ak uiCulture yo se "en-US."
3. Si la tag pa deja egziste, ajoute sa ki annapre yo , kòmantè, ak eleman nanweb> ne:web>
   Opsyon debaz vizyèl: Mete strik = "vrè" pou pa pèmèt tout konvèsyon kalite done kote pèt done ka rive. Mete eksplisit="true" pou fòse deklarasyon tout varyab yo. –>
4. Rekòmanse IIS.

Dokiman / Resous

Lojisyèl API Changepoint [pdfGid Enstalasyon API, lojisyèl, lojisyèl API

Referans

• Manyèl itilizatè