Gwida għall-Installazzjoni tal-API
Gwida ta' Referenza
Bidla 2021

© 2021 Changepoint Canada ULC Id-drittijiet kollha riżervati. DRITTIJIET TAL-GVERN TAL-Istati Uniti-Użu, duplikazzjoni, jew żvelar mill-Gvern tal-Istati Uniti huma soġġetti għal restrizzjonijiet kif stipulat fil-ftehim tal-liċenzja Changepoint Canada ULC u kif ipprovdut fid-DFARS 227.7202-1(a) u 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, jew FAR 52.227-14 (ALT III), kif applikabbli. Dan il-prodott fih informazzjoni kunfidenzjali u sigrieti kummerċjali ta' Changepoint Canada ULC. L-iżvelar huwa pprojbit mingħajr il-permess espress bil-miktub minn qabel ta 'Changepoint Canada ULC. L-użu ta 'dan il-prodott huwa suġġett għat-termini u l-kundizzjonijiet tal-Ftehim tal-Liċenzja tal-utent ma' Changepoint Canada ULC. Id-dokumentazzjoni tista' tiġi riprodotta biss mid-Detentur tal-Liċenzja għal użu intern. Il-kontenut ta' dan id-dokument ma jistax jiġi mibdul, immodifikat jew mibdul mingħajr il-kunsens espress bil-miktub ta' Changepoint Canada ULC. Changepoint Canada ULC jista' jibdel il-kontenut speċifikat hawnhekk fi kwalunkwe ħin, b'avviż jew mingħajr avviż.

Installazzjoni tal-API Changepoint

Dwar l-installazzjoni tal-API Changepoint
L-API Changepoint hija disponibbli bħala COM API, servizz tal-Windows Communication Foundation (WCF) u, għal kompatibilità b'lura, bħala Web Servizz ta’ Titjib fis-Servizzi (WSE). Għal informazzjoni dwar l-API Changepoint, ara r-Referenza tal-API Changepoint. Għal noti ta' aġġornament, twissijiet u kwistjonijiet magħrufa, ara n-Noti ta' Rilaxx fil-folders tat-tim f'Changepoint.
Aġġornament tal-API Changepoint
Jekk qed taġġorna minn verżjoni preċedenti ta' Changepoint, uża l-Panew tal-Kontroll tal-Windows biex tneħħi l-verżjoni preċedenti tal-API Changepoint u l-komponenti tagħha qabel ma tinstalla din il-verżjoni.
Rekwiżiti tal-API Changepoint
Int trid tinstalla Changepoint qabel ma tinstalla l-API Changepoint. Għar-rekwiżiti tas-softwer, ara l-Matriċi ta' Kompatibbiltà tas-Software ta' Changepoint, li hija disponibbli fil-folder tat-tim tar-Release Notes u l-Irqajja tal-2021 f'Changepoint.
File konvenzjonijiet tal-mogħdija
F'dan id-dokument, jintużaw il-konvenzjonijiet li ġejjin għal mogħdijiet komuni:

• Il-mogħdija ta' l-għerq ta' l-installazzjoni ta' Changepoint.
  Il-mogħdija default hija:
  C:Programm Files (x86)ChangepointChangepoint
• L-għerq tal-post għall-utilitajiet ta' Changepoint komuni, bħall-utilità tal-Issettjar tal-Login.
  Il-mogħdija default hija:
  C:Programm Files (x86) Komuni FilesChangepointChangepoint

Installazzjoni tal-API Changepoint

1. Mid-direttorju tal-għeruq tal-midja Changepoint API, mexxi setup.exe.
2. Segwi l-istruzzjonijiet sakemm tidher l-iskrin Select Features.
3. Agħżel il-karatteristiċi li trid tinstalla, imbagħad ikklikkja Li jmiss.
4. Agħżel il-folder tad-destinazzjoni tal-API, default API, u kklikkja Li jmiss.
   Nota: L-utilità Changepoint Login Settings hija installata fi LoginSettings, irrispettivament mill-folder tad-destinazzjoni li tispeċifika.
5. Jekk għażilt il Web Servizzi API: a. Meta l-Agħżel
   a Web Jidher l-iskrin tas-sit, agħżel a websit biex iżżid id-direttorju virtwali miegħu, u mbagħad ikklikkja Li jmiss.
   b. Ikklikkja Li jmiss biex tkompli. 6. Meta l-installazzjoni tal-API tkun kompluta, ikklikkja Finish.

Konfigurazzjoni tal-API Changepoint biex tkun konxja tal-cache
Biex tikkonfigura l-API Changepoint biex tkun konxja mill-cache, ibdel il-valuri għall-"cache. Password” u “cache. Servers” ċwievet fis-CP Web ServizziWeb.config file bil-valuri użati fl-IntrapriżaWeb.config file.
Abilitazzjoni Web Titjib fis-Servizzi (WSE)

1. Editja l- Web.config file għal web servizzi. Il-post default huwa:
   APICP Web ServizziWeb.config
2. Sib it-tliet każijiet tal-linja tal-kumment li ġejja:
   < !– Neħħi l-kumment l-element li ġej jekk qed tuża Web Titjib fis-Servizz (WSE) API. Ħalli l-kummenti jekk tuża servizzi WCF u mhux qed tinstalla Web Titjib fis-Servizz (WSE) –>
3. Neħħi l-kumment l-element li jsegwi kull istanza tal-linja tal-kumment:
   <section name=”microsoft.web.services2″ … >webServizzi>web.servizzi2>
   Nota: Il-webServizzi> element li ma jkunx kummentat huwa wild taweb>.

Konfigurazzjoni tal-illoggjar għall- Web Servizzi API
Trid issettja l-log file passaġġ u livelli ta' log. Il-livelli tal-log huma kumulattivi. Per example, jekk tispeċifika l-livell 3, allura l-livelli 1, 2, u 3 jiġu illoggjati. Il-livell tal-log default huwa 8.

1. Editja l- web servizzi Web.config. Il-post default huwa:
   APICP Web ServizziWeb.config
2. Issettja l-LogFileMogħdija. Il-valur default huwa APIAPILogs. 3. Issettja l-LogLevel. Il-valuri validi huma:
   0 = L-ebda qtugħ
   1 = Oġġett u metodu tas-sors
   2 = Messaġġ ta' żball
   3 = Parametri tad-dħul
   4 = Ritorni
   5 = Twissija
   8 = Punt ta' kontroll

Konfigurazzjoni ta' awtentikazzjoni tad-direttorju virtwali għall- Web Servizzi API
Trid tattiva aċċess anonimu u tiddiżattiva l-awtentikazzjoni Integrata tal-Windows għas-CPWebDirettorju virtwali tas-servizz fis-Servizzi tal-Informazzjoni tal-Internet (IIS). Għal aktar informazzjoni, ara d-dokumentazzjoni tal-Microsoft IIS.
Konfigurazzjoni tas-settings tal-konnessjoni tad-database għall- Web Servizzi API
Uża l-utilità Login Settings biex tikkriptaġġ is-settings tal-konnessjoni tad-database fil- Web Servizzi API Web.config file. Għal aktar informazzjoni, fittex “Konfigurazzjoni tas-Settings tal-Konnessjoni tad-Database” fil-Gwida għall-Installazzjoni tal-Point tal-Bidla.
Konfigurazzjoni tal-awtentikazzjoni għal Changepoint WCF Web Servizzi
Tista' tikkonfigura l-Awtentikazzjoni tal-Applikazzjoni u l-Single Sign-on (SSO) għal Changepoint WCF Web Servizzi.
L-għażliet ta' implimentazzjoni li ġejjin huma disponibbli bl-użu ta' Secure Token Service (STS):

• SSO bl-użu ta' ISAPI SSL mhux obbligatorju
• SSO bl-użu ta' WS-Federation (ADFS 2.0) SSL meħtieġ

Jekk SSL huwa meħtieġ, l-iskrittura tal-konfigurazzjoni tiżgura li tintuża.
L-iskripts tal-konfigurazzjoni għall-ISAPI u l-awtentikazzjoni tal-applikazzjoni jistgħu b'mod fakultattiv jippermettu SSL.
Konfigurazzjoni tal-awtentikazzjoni tal-applikazzjoni għal WCF Web Servizzi
It-tip ta' awtentikazzjoni default għal Changepoint WCF Web Is-servizzi huma awtentikazzjoni tal-applikazzjoni.
Uża l-proċeduri f'din it-taqsima biex:

• kkonfigurat Changepoint WCF Web Servizzi biex tuża l-awtentikazzjoni tal-applikazzjoni bl-SSL
• ireġġa 'lura Changepoint WCF Web Servizzi għall-awtentikazzjoni tal-applikazzjoni wara li tkun implimentat waħda mill-implimentazzjonijiet tal-SSO

Ikkonfigura PowerShell

1. Iftaħ pront tal-Windows PowerShell.
2. Immodifika l-politika ta' eżekuzzjoni:
   Set-ExecutionPolicy Unrestricted

Stage 1 Iġbor il-parametri tal-konfigurazzjoni
Iddetermina l-valuri għall-parametri tal-konfigurazzjoni.

Parametru	Deskrizzjoni
WebService_Path	Post tal-WCF tal-Bidla Web Servizzi web applikazzjoni files. Default: \API\CP Web Servizzi
Ċertifikat tas-Servizz_ Isem	Isem taċ-ċertifikat li se jintuża biex jawtentika s-servizz lill-klijenti li jużaw il-mod tas-sigurtà tal-Messaġġ. Default: l-Isem taċ-Ċertifikat “CN=ChangepointAPICertificate”.
jeħtieġu HTTPS	Jeħtieġ HTTPS (Veru/Falz) Default: Falz.

Stage 2 Esegwixxi skripts ta' konfigurazzjoni
Uża l-valuri għall-parametri tal-konfigurazzjoni biex timmodifika l-konfigurazzjoni tal- websiti.

1.  Iftaħ pront ta' PowerShell.
   Nota: Jekk is-server tiegħek għandu l-Kontroll tal-Kont tal-Utent attivat, trid tiftaħ il-pront ta' PowerShell billi tuża permessi ta' amministratur elevati.
2. Innaviga lejn is-CP web direttorju tal-konfigurazzjoni tas-servizz, default:
   KonfigurazzjoniCPWebServizz
3.  Eżegwixxi ./Configuration_AppAuth.ps1
4. Segwi l-istruzzjonijiet.

Konfigurazzjoni ta' single sign-on (SSO) għal WCF Web Servizzi
Ikkonfigura PowerShell

1. Iftaħ pront tal-Windows PowerShell.
2. Immodifika l-politika ta' eżekuzzjoni:
   Set-ExecutionPolicy Unrestricted

Konfigurazzjoni ta 'SSO bl-użu ta' ISAPI għal WCF Web Servizzi
Stage 1 Iġbor il-parametri tal-konfigurazzjoni
Iddetermina l-valuri għall-parametri tal-konfigurazzjoni li ġejjin.

Parametru	Deskrizzjoni
WebService_Path	Il-post tal-WCF Changepoint Web Servizzi web applikazzjoni files. Default: \API\CP Web Servizzi
jeħtieġu HTTPS	Jeħtieġ HTTPS (Veru/Falz). Default: Falz.
Bidla_punt_RSA_ Cookie_Transform	L-isem taċ-ċertifikat li tuża għall-encryption tal-Cookies. Default: l-Isem taċ-Ċertifikat “CN=ChangepointAPICertificate”.
Isem taċ-Ċertifikat tas-Servizz	Daħħal l-isem taċ-ċertifikat li se jintuża biex jawtentika s-servizz lill-klijenti li jużaw il-mod tas-sigurtà tal-Messaġġ. Default: l-Isem taċ-Ċertifikat “CN=ChangepointAPICertificate”.
Isem taċ-Ċertifikat tal-Firma	Daħħal l-isem taċ-ċertifikat tal-iffirmar. Dan huwa l-isem taċ-ċertifikat li tuża biex tiffirma messaġġi. Default: l-Isem taċ-Ċertifikat “CN=ChangepointAPICertificate”.
ISAPI_Mode	Il-mod ISAPI. Default: NT
ISAPI_Header	L-intestatura użata meta ISAPI_Mode hija "HEADER", pereżempjuample, vojt.
ClaimType	Daħħal it-Tip ta' Talba SSO. Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Esegwixxi skripts ta' konfigurazzjoni

1. Iftaħ pront ta' PowerShell.
   Nota: Jekk is-server tiegħek għandu l-Kontroll tal-Kont tal-Utent attivat, trid tiftaħ il-pront ta' PowerShell billi tuża permessi ta' amministratur elevati.
2. Innaviga lejn is-CP web direttorju tal-konfigurazzjoni tas-servizz, default:
   KonfigurazzjoniCPWebServizz
3. Eżegwixxi: ./Configuration_SSO_ISAPI.ps1
4. Segwi l-istruzzjonijiet.

Konfigurazzjoni ta 'SSO bl-użu ta' WS-Federation (ADFS 2.0) għal WCF Web Servizzi
Stage 1 Iġbor il-parametri tal-konfigurazzjoni
Iddetermina l-valuri għall-parametri tal-konfigurazzjoni fit-tabella, hawn taħt. Kun żgur li l-ADFS_Server_URI jinsab fiż-żona tal-Intranet tal-browser tal-utent finali.
Nota: B'mod awtomatiku, Changepoint huwa kkonfigurat biex jaġġorna awtomatikament iċ-ċwievet pubbliċi li jintużaw biex jiffirmaw it-tokens tas-sigurtà billi juża d-dokument tal-metadejta tal-federazzjoni ppubblikat. Fl-ADFS dan huwa:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
F'xi każijiet jista' ma jkunx possibbli li tilħaq is-server ADFS mill-Point tal-Bidla web server sabiex ikollok taġġorna manwalment il-konfigurazzjoni wara li tħaddem l-iskrittura tal-konfigurazzjoni. Għad-dettalji, ara “Aġġornament manwalment taċ-ċwievet pubbliċi” f’paġna 12.

Parametru	Deskrizzjoni
WebService_Path	Post tal-WCF tal-Bidla Web Servizzi web applikazzjoni files. Default: \API\CP Web Servizzi
WebService_URI	Identifikatur tad-dominju li tuża għal Changepoint WCF Web Servizzi. Per example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Isem taċ-ċertifikat li tuża għall-encryption tal-Cookies. Default: l-Isem taċ-Ċertifikat “CN=ChangepointApiCertificate”.
Isem taċ-Ċertifikat tas-Servizz	Isem taċ-ċertifikat li se jintuża biex jawtentika s-servizz lill-klijenti li jużaw il-mod tas-sigurtà tal-Messaġġ. Default: l-Isem taċ-Ċertifikat “CN=ChangepointApiCertificate”.
Isem taċ-Ċertifikat tal-Firma	Isem taċ-ċertifikat li tuża għall-iffirmar tal-messaġġi. Default: l-Isem taċ-Ċertifikat “CN=ChangepointApiCertificate” jintuża.
ADFS_ FederationServiceName	Isem tas-Servizz tal-Federazzjoni. Biex tikseb l-isem: Mis-server ADFS, Tnedija ADFS 2.0 console ta 'ġestjoni. •Agħżel ADFS 2.0 mill-menu tax-xellug. •Mill-pane Azzjoni agħżel Edit Federation Service Properties. L-Isem tas-Servizz tal-Federazzjoni jinsab fit-tab Ġenerali.
ClaimType	Tip ta' Talba SSO. In-nuqqas huwa: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Esegwixxi skripts ta' konfigurazzjoni
Ikkonfigura l- websiti li jużaw il-valuri għall-parametri tal-konfigurazzjoni.

1. Iftaħ pront ta' PowerShell.
   Nota: Jekk is-server tiegħek għandu l-Kontroll tal-Kont tal-Utent attivat, trid tiftaħ il-pront ta' PowerShell billi tuża permessi ta' amministratur elevati.
2. Innaviga sal-punt tal-bidla web direttorju tal-konfigurazzjoni tas-servizz, default: KonfigurazzjoniCPWebServizz
3.  Eżegwixxi: ./Configuration_SSO_ADFS.ps1
4. Segwi l-istruzzjonijiet.

Stage 3 Oħloq fiduċja tal-parti li tiddependi
Oħloq il-Fiduċja tal-Parti li Tistrieħ f'ADFS 2.0 Console.

1. Fuq is-server ADFS tiegħek, iniedi l-console ADFS 2.0.
2. Agħżel Azzjoni > Żid Trust Relying Party.
3. Ikklikkja Ibda.
4. Agħżel Importa data dwar il-parti li tiddependi ppubblikata online jew fuq netwerk lokali.
5. Daħħal l-indirizz tal-metadejta tal-Federazzjoni, u mbagħad ikklikkja Li jmiss, pereżempjuample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Daħħal isem Display, eż. Changepoint WCF API, u kklikkja Li jmiss, Li jmiss, Li jmiss, imbagħad Agħlaq.
7. Żid Regola ta' Talba għall-Parti li Tistrieħ fuq il-Bidla ta' hawn fuq. Għal Changepoint, l-isem default tar-regola tat-Talba huwa "UPN".
8. Immappja l-Attribut LDAP “User-Principal-Name” mat-Tip ta’ Talba Outgoing “* UPN” jew “UPN”.

Aġġorna manwalment iċ-ċwievet pubbliċi
Biex tikseb l-ADFS Server Token Signing Thumbprint

1. Mis-server ADFS, Tnedija ADFS 2.0 console ta 'ġestjoni.
2. Agħżel Servizz > Ċertifikati, u ikklikkja darbtejn fuq iċ-ċertifikat tal-iffirmar tat-Token.
3. Agħżel it-tab Dettalji.
4. Agħżel il-qasam Thumbprint.
5. Biex tikseb il-valur tal-marki thumbprint, neħħi l-ispazji kollha inkluż l-ewwel spazju.

Biex taġġorna l- Web.config file

1. Editja l-ADFS web.config. Il-post default huwa:
   EnterpriseRP-STS_ADFS
2. Taħt il- element, sib iċ-ċavetta ida:FederationMetadataLocation u neħħi l-valur tagħha:
   
3. Taħt , issib il- element u tibdilha b'dan li ġej: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Ittestjar tal-konnessjoni COM API

1. Mexxi l-API Test Kit. Il-post default huwa:
   Komponenti APIAPIApiTestKit.exe.
2. Ikklikkja String ta 'Konnessjoni > Encrypter.
3. Fil-qasam String ta' Konnessjonijiet ta' Test sempliċi:
   a. Ibdel SERVERNAME u DATABASENAME bl-informazzjoni tad-database tiegħek.
   b. Ibdel USERID u PASSWORD bl-informazzjoni tal-kont tal-utent tal-amministratur tad-database tiegħek.
   c. Daħħal il-valur tal-timeout kif meħtieġ.
4. Ikklikkja Encrypt.
5. Fil-qasam String ta 'Konnessjoni Encrypted, kopja t-test.
6. Agħlaq il-kaxxa tad-djalogu.
7. Fuq il-menu tal-Kit tat-Test tal-API, ikklikkja Konnessjoni > Tester tal-Konnessjoni tal-API COM.
8. Fit-tab Verżjoni Kurrenti, waħħal is-sekwenza tal-konnessjoni kriptata fil-qasam String ta 'Konnessjoni.
9. Fl-oqsma LoginId u Password, daħħal l-ID tal-login u l-password għall-kont Changepoint tiegħek.
10. Fil-qasam Loglevel (0-8), speċifika l-livell ta’ informazzjoni ta’ żball li trid tiġi rritornata fir-reġistru tal-API COM file jekk ir-riżultat tat-test juri problema bil-konnessjoni.
    0 = L-ebda qtugħ
    1 = Oġġett u metodu tas-sors
    2 = Messaġġ ta' żball
    3 = Parametri tad-dħul
    4 = Ritorni
    5 = Twissija
    8 = Punt ta' kontroll
    Id-default huwa 8.
11. Ikklikkja Connect.
    Jekk il-konnessjoni kienet ta' suċċess, jintwera messaġġ ta' suċċess fil-qasam Riżultat. Jekk il-konnessjoni falliet, iċċekkja l-ġurnal COM API file għall-iżbalji. Il-post default tar-reġistru file huwa APIAPILogs.

Iċċekkja l-verżjoni tal-komponenti tal-API installati
Tista 'tuża l-utilità tal-kontroll tal-verżjoni biex tikseb dettalji dwar il-komponenti installati, inklużi l-verżjoni u l-passaġġ tar-rilaxx.

1. Mexxi CPVersionChecker.exe. Il-mogħdija default hija: Komponenti APIAPI
2. Ikklikkja Aqra.

Iċċekkja l-verżjoni tal- Web Servizzi API

1. Tnedija Internet Explorer mis-server fejn il- Web Servizzi API huwa installat, u daħħal l-indirizz:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  fejn port huwa n-numru tal-port tal- websit fejn installajt is-CPWebDirettorju virtwali tas-servizz.
2. Fuq il-paġna WSLogin, ikklikkja l-link GetVersion.
3. Ikklikkja Invoke.

Ittestjar tal- Web Servizzi konnessjoni API

1. Tnedija Internet Explorer mis-server fejn il- Web Servizzi API huwa installat, u daħħal l-indirizz: http://localhost.port/CPWeb.Service/WSLogin.asmx  fejn port huwa n-numru tal-port tal- websit fejn installajt is-CPWebDirettorju virtwali tas-servizz.
2. Fuq il-paġna WSLogin ikklikkja l-link TestConnection.
3. Ikklikkja Invoke. 4. Fir-riżultati tat-test:

• Jekk element huwa falz, il-konnessjoni tat-test irnexxielha.
• Jekk element huwa veru, il-konnessjoni tat-test falliet. Għal aktar
  informazzjoni dwar ir-raġunijiet għan-nuqqas, ara l- u elementi fir-riżultati tat-test, u ċċekkja r-reġistri tal-API. Il-mogħdija default għar-reġistri tal-API hija: APIAPILogs

It-twaqqif tal- Web Servizzi API fuq server tal-lingwa

1. Biex tuża l-Point tal-Bidla Web Servizzi API fuq server tal-lingwa, trid iżżid jew taġġorna l- tag fil- Web Servizzi API web.config. Il-post default tal- Web.config file huwa: APICP Web ServizziWeb.config
2. Jekk il- tag diġà teżisti, żgura li kemm l-attributi tal-kultura kif ukoll tal-uiCulture huma "en-US."
3. Jekk il- tag ma teżistix diġà, żid dan li ġej , kummenta, u elementi għall-web> node:web>
   Għażliet Viżwali Bażiċi: Issettja stretta = "veru" biex ma tħallix il-konverżjonijiet kollha tat-tip tad-data fejn jista 'jseħħ telf ta' data. Issettja espliċita="true" biex tisforza d-dikjarazzjoni tal-varjabbli kollha. –>
4. Erġa 'ibda l-IIS.

Dokumenti / Riżorsi

Changepoint API Software [pdfGwida għall-Installazzjoni API, Software, API Software

Referenzi

• Manwal għall-Utent