Navodila za namestitev API-ja
Referenčni vodnik
Točka spremembe 2021

© 2021 Changepoint Canada ULC Vse pravice pridržane. PRAVICE VLADE ZDA – Uporaba, podvajanje ali razkritje s strani vlade ZDA je predmet omejitev, kot je določeno v licenčni pogodbi Changepoint Canada ULC in kot je določeno v DFARS 227.7202-1(a) in 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19 ali FAR 52.227-14 (ALT III), kot je primerno. Ta izdelek vsebuje zaupne podatke in poslovne skrivnosti Changepoint Canada ULC. Razkritje je prepovedano brez predhodnega izrecnega pisnega dovoljenja Changepoint Canada ULC. Za uporabo tega izdelka veljajo določila in pogoji uporabnikove licenčne pogodbe s podjetjem Changepoint Canada ULC. Imetnik licence lahko dokumentacijo razmnožuje samo za interno uporabo. Vsebine tega dokumenta ni dovoljeno spreminjati, spreminjati ali spreminjati brez izrecnega pisnega soglasja Changepoint Canada ULC. Changepoint Canada ULC lahko kadar koli spremeni vsebino, navedeno v tem dokumentu, z obvestilom ali brez njega.

Namestitev API-ja Changepoint

O namestitvi API-ja Changepoint
API Changepoint je na voljo kot COM API, storitev Windows Communication Foundation (WCF) in za združljivost s prejšnjimi različicami kot Web Storitev Services Enhancements (WSE). Za informacije o API-ju Changepoint glejte Referenco API-ja Changepoint. Za opombe o nadgradnji, opozorila in znane težave si oglejte opombe ob izdaji v mapah skupine v Changepoint.
Nadgradnja API-ja Changepoint
Če nadgrajujete s prejšnje izdaje Changepoint, uporabite nadzorno ploščo Windows, da odstranite prejšnjo različico API-ja Changepoint in njegovih komponent, preden namestite to različico.
Zahteve API-ja Changepoint
Preden namestite Changepoint API, morate namestiti Changepoint. Za zahteve glede programske opreme glejte matriko združljivosti programske opreme Changepoint, ki je na voljo v mapi Opombe ob izdaji in popravki 2021 skupine v Changepoint.
File konvencije poti
V tem dokumentu se za pogoste poti uporabljajo naslednje konvencije:

• Korenska pot namestitve Changepoint.
  Privzeta pot je:
  C: Program Files (x86)Točka spremembeTočka spremembe
• Korenska lokacija za običajne pripomočke Changepoint, kot je pripomoček za nastavitve prijave.
  Privzeta pot je:
  C: Program Files (x86) Pogosto FilesChangepointChangepoint

Namestitev API-ja Changepoint

1. Iz korenskega imenika medijev API-ja Changepoint zaženite setup.exe.
2. Sledite pozivom, dokler se ne prikaže zaslon Select Features.
3. Izberite funkcije, ki jih želite namestiti, nato kliknite Naprej.
4. Izberite ciljno mapo API, privzeto API in kliknite Naprej.
   Opomba: Pripomoček Changepoint Login Settings je nameščen v LoginSettings, ne glede na ciljno mapo, ki jo določite.
5. Če ste izbrali Web API storitev: a. Ko se prikaže Select
   a Web Prikaže se zaslon spletnega mesta, izberite a webmesto, kamor želite dodati navidezni imenik, in nato kliknite Naprej.
   b. Za nadaljevanje kliknite Naprej. 6. Ko je namestitev API-ja končana, kliknite Dokončaj.

Konfiguriranje API-ja Changepoint za upoštevanje predpomnilnika
Če želite API Changepoint konfigurirati tako, da se zaveda predpomnilnika, zamenjajte vrednosti za »cache. Geslo« in »predpomnilnik. Strežniki« v CP Web StoritveWeb.config file z vrednostmi, ki se uporabljajo v podjetjuWeb.config file.
Omogočanje Web Izboljšave storitev (WSE)

1. Uredi Web.config file za web storitve. Privzeta lokacija je:
   APICP Web StoritveWeb.config
2. Poiščite tri primere te vrstice komentarja:
   < !– Odkomentirajte naslednji element, če ga uporabljate Web API za izboljšave storitev (WSE). Pustite komentarje, če uporabljate storitve WCF in ne nameščate Web Izboljšave storitve (WSE) –>
3. Odkomentirajte element, ki sledi vsakemu primerku vrstice komentarja:
   <section name=”microsoft.web.services2″ … >webStoritve>web.storitve2>
   Opomba: ThewebStoritve> element, ki ga je treba odkomentirati, je podrejeniweb>.

Konfiguriranje beleženja za Web API storitev
Nastaviti morate dnevnik file ravni poti in dnevnika. Ravni dnevnika so kumulativne. Na primerample, če podate raven 3, se zabeležijo ravni 1, 2 in 3. Privzeta raven dnevnika je 8.

1. Uredi web storitve Web.config. Privzeta lokacija je:
   APICP Web StoritveWeb.config
2. Nastavite dnevnikFilePot. Privzeta vrednost je APIAPILogs. 3. Nastavite LogLevel. Veljavne vrednosti so:
   0 = Brez beleženja
   1 = Izvorni objekt in metoda
   2 = Sporočilo o napaki
   3 = Vhodni parametri
   4 = Vrnitve
   5 = Opozorilo
   8 = kontrolna točka

Konfiguriranje preverjanja pristnosti navideznega imenika za Web API storitev
Za CP morate omogočiti anonimni dostop in onemogočiti integrirano preverjanje pristnosti sistema WindowsWebStoritveni virtualni imenik v internetnih informacijskih storitvah (IIS). Za več informacij glejte dokumentacijo Microsoft IIS.
Konfiguriranje nastavitev povezave z bazo podatkov za Web API storitev
Uporabite pripomoček Login Settings za šifriranje nastavitev povezave z bazo podatkov v Web API storitev Web.config file. Za več informacij poiščite »Konfiguriranje nastavitev povezave z bazo podatkov« v Vodiču za namestitev Changepoint.
Konfiguriranje preverjanja pristnosti za Changepoint WCF Web Storitve
Konfigurirate lahko preverjanje pristnosti aplikacije in enotno prijavo (SSO) za Changepoint WCF Web Storitve.
Z uporabo storitve Secure Token Service (STS) so na voljo naslednje izvedbene možnosti:

• SSO z uporabo ISAPI SSL izbirno
• SSO z uporabo WS-Federation (ADFS 2.0) Potreben je SSL

Če je zahtevan SSL, konfiguracijski skript zagotovi njegovo uporabo.
Konfiguracijski skripti za ISAPI in preverjanje pristnosti aplikacij lahko po želji omogočijo SSL.
Konfiguriranje avtentikacije aplikacije za WCF Web Storitve
Privzeta vrsta preverjanja pristnosti za Changepoint WCF Web Storitve so avtentikacija aplikacij.
Uporabite postopke v tem razdelku za:

• konfigurirajte Changepoint WCF Web Storitve za uporabo avtentikacije aplikacij s SSL
• povrni točko spremembe WCF Web Storitve za avtentikacijo aplikacij po implementaciji ene od implementacij SSO

Konfigurirajte PowerShell

1. Odprite poziv Windows PowerShell.
2. Spremenite politiko izvajanja:
   Set-ExecutionPolicy Unrestricted

Stage 1 Zberite konfiguracijske parametre
Določite vrednosti za konfiguracijske parametre.

Parameter	Opis
WebService_Path	Lokacija menjalne točke WCF Web Storitve web aplikacija files. Privzeto: \API\CP Web Storitve
ServiceCertificate_ Ime	Ime potrdila, ki bo uporabljeno za preverjanje pristnosti storitve za odjemalce z uporabo varnostnega načina sporočila. Privzeto: ime potrdila »CN=ChangepointAPICertificate«.
zahtevajo HTTPS	Zahtevaj HTTPS (True/False) Privzeto: False.

Stage 2 Izvedite konfiguracijske skripte
Uporabite vrednosti za konfiguracijske parametre, da spremenite konfiguracijo webstrani.

1.  Odprite poziv PowerShell.
   Opomba: Če ima vaš strežnik omogočen nadzor uporabniškega računa, morate odpreti poziv PowerShell s povišanimi skrbniškimi dovoljenji.
2. Pomaknite se do CP web konfiguracijski imenik storitve, privzeto:
   KonfiguracijaCPWebStoritev
3.  Izvedite ./Configuration_AppAuth.ps1
4. Sledite navodilom.

Konfiguriranje enotne prijave (SSO) za WCF Web Storitve
Konfigurirajte PowerShell

1. Odprite poziv Windows PowerShell.
2. Spremenite politiko izvajanja:
   Set-ExecutionPolicy Unrestricted

Konfiguriranje SSO z uporabo ISAPI za WCF Web Storitve
Stage 1 Zberite konfiguracijske parametre
Določite vrednosti za naslednje konfiguracijske parametre.

Parameter	Opis
WebService_Path	Lokacija menjalne točke WCF Web Storitve web aplikacija files. Privzeto: \API\CP Web Storitve
zahtevajo HTTPS	Zahtevaj HTTPS (True/False). Privzeto: False.
Changepoint_RSA_ Cookie_Transform	Ime potrdila, ki ga uporabljate za šifriranje piškotkov. Privzeto: ime potrdila »CN=ChangepointAPICertificate«.
ServiceCertificate_Name	Vnesite ime potrdila, ki bo uporabljeno za preverjanje pristnosti storitve za odjemalce z uporabo varnostnega načina sporočil. Privzeto: ime potrdila »CN=ChangepointAPICertificate«.
SigningCertificate_Name	Vnesite ime podpisnega potrdila. To je ime potrdila, ki ga uporabljate za podpisovanje sporočil. Privzeto: ime potrdila »CN=ChangepointAPICertificate«.
ISAPI_Mode	Način ISAPI. Privzeto: NT
ISAPI_Header	Glava, uporabljena, ko je ISAPI_Mode »HEADER«, nprample, prazno.
ClaimType	Vnesite vrsto zahtevka SSO. Privzeto: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Izvedite konfiguracijske skripte

1. Odprite poziv PowerShell.
   Opomba: Če ima vaš strežnik omogočen nadzor uporabniškega računa, morate odpreti poziv PowerShell s povišanimi skrbniškimi dovoljenji.
2. Pomaknite se do CP web konfiguracijski imenik storitve, privzeto:
   KonfiguracijaCPWebStoritev
3. Izvedite: ./Configuration_SSO_ISAPI.ps1
4. Sledite navodilom.

Konfiguriranje enotne prijave z uporabo WS-Federation (ADFS 2.0) za WCF Web Storitve
Stage 1 Zberite konfiguracijske parametre
Določite vrednosti za konfiguracijske parametre v spodnji tabeli. Prepričajte se, da je ADFS_Server_URI v intranetnem območju brskalnika končnega uporabnika.
Opomba: Privzeto je Changepoint konfiguriran za samodejno posodabljanje javnih ključev, ki se uporabljajo za podpisovanje varnostnih žetonov, z uporabo objavljenega dokumenta z metapodatki zveze. V ADFS je to:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
V nekaterih primerih morda ne bo mogoče doseči strežnika ADFS iz Changepoint web strežnik, tako da boste morali po zagonu konfiguracijskega skripta ročno posodobiti konfiguracijo. Za podrobnosti glejte “Ročno posodabljanje javnih ključev” na strani 12.

Parameter	Opis
WebService_Path	Lokacija menjalne točke WCF Web Storitve web aplikacija files. Privzeto: \API\CP Web Storitve
WebService_URI	Identifikator domene, ki ga uporabljate za Changepoint WCF Web Storitve. Na primerample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Ime potrdila, ki ga uporabljate za šifriranje piškotkov. Privzeto: ime potrdila »CN=ChangepointApiCertificate«.
ServiceCertificate_Name	Ime potrdila, ki bo uporabljeno za preverjanje pristnosti storitve za odjemalce z uporabo varnostnega načina sporočila. Privzeto: ime potrdila »CN=ChangepointApiCertificate«.
SigningCertificate_Name	Ime potrdila, ki ga uporabljate za podpisovanje sporočil. Privzeto: uporabljeno je ime potrdila »CN=ChangepointApiCertificate«.
ADFS_ FederationServiceName	Ime storitve zveze. Če želite pridobiti ime: Na strežniku ADFS zaženite konzolo za upravljanje ADFS 2.0. • V levem meniju izberite ADFS 2.0. • V podoknu z dejanji izberite Edit Federation Service Properties. Ime storitve Federation je na zavihku Splošno.
ClaimType	Vrsta zahtevka SSO. Privzeto je: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Izvedite konfiguracijske skripte
Konfigurirajte webmesta z uporabo vrednosti za konfiguracijske parametre.

1. Odprite poziv PowerShell.
   Opomba: Če ima vaš strežnik omogočen nadzor uporabniškega računa, morate odpreti poziv PowerShell s povišanimi skrbniškimi dovoljenji.
2. Pomaknite se do Changepoint web konfiguracijski imenik storitve, privzeto: KonfiguracijaCPWebStoritev
3.  Izvedite: ./Configuration_SSO_ADFS.ps1
4. Sledite navodilom.

Stage 3 Ustvarite zaupanje odvisne stranke
Ustvarite zaupanje odvisne stranke v konzoli ADFS 2.0.

1. Na strežniku ADFS zaženite konzolo ADFS 2.0.
2. Izberite Action > Add Relying Party Trust.
3. Kliknite Start.
4. Izberite Uvozi podatke o odvisni stranki, objavljene na spletu ali v lokalnem omrežju.
5. Vnesite naslov zveznih metapodatkov in kliknite Naprej, nprample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Vnesite prikazno ime, npr. Changepoint WCF API, in kliknite Naprej, Naprej, Naprej in nato Zapri.
7. Dodajte pravilo zahtevka za zgornjo odvisno stranko Changepoint. Za Changepoint je privzeto ime pravila zahtevanja »UPN«.
8. Preslikajte atribut LDAP »User-Principal-Name« v vrsto odhodnega zahtevka »* UPN« ali »UPN«.

Ročno posodabljanje javnih ključev
Za pridobitev odtisa podpisnega žetona strežnika ADFS

1. S strežnika ADFS zaženite konzolo za upravljanje ADFS 2.0.
2. Izberite Storitev > Potrdila in dvokliknite potrdilo za podpisovanje žetonov.
3. Izberite zavihek Podrobnosti.
4. Izberite polje Thumbprint.
5. Če želite pridobiti vrednost odtisa palca, odstranite vse presledke, vključno s prvim presledkom.

Za posodobitev Web.config file

1. Uredite ADFS web.config. Privzeta lokacija je:
   EnterpriseRP-STS_ADFS
2. Pod element, poiščite ključ ida:FederationMetadataLocation in počistite njegovo vrednost:
   
3. Spodaj , Poišči in ga nadomestite z naslednjim: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Testiranje povezave COM API

1. Zaženite testni komplet API-ja. Privzeta lokacija je:
   Komponente APIAPIApiTestKit.exe.
2. Kliknite Connection String > Encrypter.
3. V polju Niz povezav z navadnim besedilom:
   a. Zamenjajte SERVERNAME in DATABASENAME s podatki o vaši bazi podatkov.
   b. Zamenjajte USERID in PASSWORD s podatki o uporabniškem računu skrbnika zbirke podatkov.
   c. Po potrebi vnesite vrednost časovne omejitve.
4. Kliknite Šifriraj.
5. V polje Šifrirani povezovalni niz kopirajte besedilo.
6. Zaprite pogovorno okno.
7. V meniju API Test Kit kliknite Povezava > COM API Connection Tester.
8. Na zavihku Trenutna različica prilepite šifriran niz povezave v polje Niz povezave.
9. V polji LoginId in Password vnesite ID za prijavo in geslo za svoj račun Changepoint.
10. V polju Loglevel (0-8) določite raven informacij o napaki, ki naj se vrne v dnevnik COM API file če rezultat testa pokaže težavo s povezavo.
    0 = Brez beleženja
    1 = Izvorni objekt in metoda
    2 = Sporočilo o napaki
    3 = Vhodni parametri
    4 = Vrnitve
    5 = Opozorilo
    8 = kontrolna točka
    Privzeto je 8.
11. Kliknite Poveži.
    Če je bila povezava uspešna, se v polju za rezultat prikaže sporočilo o uspehu. Če povezava ni uspela, preverite dnevnik COM API file za napake. Privzeta lokacija dnevnika file je APIAPILogs.

Preverjanje različice nameščenih komponent API
Za pridobitev podrobnosti o nameščenih komponentah, vključno z različico izdaje in potjo, lahko uporabite pripomoček za preverjanje različic.

1. Zaženite CPVersionChecker.exe. Privzeta pot je: Komponente APIAPI
2. Kliknite Preberi.

Preverjanje različice Web API storitev

1. Zaženite Internet Explorer s strežnika, kjer je Web Services API je nameščen in vnesite naslov:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  kjer je port številka vrat webmesto, kjer ste namestili CPWebStoritveni virtualni imenik.
2. Na strani WSLogin kliknite povezavo GetVersion.
3. Kliknite Priklic.

Preizkušanje Web Povezava API storitev

1. Zaženite Internet Explorer s strežnika, kjer je Web Services API je nameščen in vnesite naslov: http://localhost.port/CPWeb.Service/WSLogin.asmx  kjer je port številka vrat webmesto, kjer ste namestili CPWebStoritveni virtualni imenik.
2. Na strani WSLogin kliknite povezavo TestConnection.
3. Kliknite Priklic. 4. V rezultatih testa:

• če element je napačen, testna povezava uspela.
• če element je res, testna povezava ni uspela. Za več
  informacije o razlogih za neuspeh glejte in elemente v rezultatih testa in preverite dnevnike API-ja. Privzeta pot do dnevnikov API-ja je: APIAPILogs

Nastavitev Web Storitve API na jezikovnem strežniku

1. Za uvedbo Changepoint Web Services API na jezikovnem strežniku morate dodati ali posodobiti tag v Web API storitev web.config. Privzeta lokacija za Web.config file je: APICP Web StoritveWeb.config
2. Če je tag že obstaja, zagotovite, da sta atributa kulture in uiCulture »en-US«.
3. Če je tag še ne obstaja, dodajte naslednje , komentiraj in elementi zaweb> vozlišče:web>
   Možnosti Visual Basic: Nastavite strict=”true”, da onemogočite vse pretvorbe podatkovnih vrst, kjer lahko pride do izgube podatkov. Nastavite explicit=”true”, da vsilite deklaracijo vseh spremenljivk. –>
4. Znova zaženite IIS.

Dokumenti / Viri

Programska oprema API Changepoint [pdf] Navodila za namestitev API, programska oprema, programska oprema API

Reference

• Uporabniški priročnik