Průvodce instalací API
Referenční příručka
Bod změny 2021
© 2021 Changepoint Canada ULC Všechna práva vyhrazena. PRÁVA VLÁDY USA – Použití, duplikace nebo zveřejnění vládou USA podléhá omezením stanoveným v licenční smlouvě Changepoint Canada ULC a jak je uvedeno v DFARS 227.7202-1(a) a 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (říjen 1988), FAR 12.212(a) (1995), FAR 52.227-19 nebo FAR 52.227-14 (ALT III), podle potřeby. Tento produkt obsahuje důvěrné informace a obchodní tajemství společnosti Changepoint Canada ULC. Zveřejnění je zakázáno bez předchozího výslovného písemného souhlasu Changepoint Canada ULC. Použití tohoto produktu podléhá podmínkám licenční smlouvy uživatele se společností Changepoint Canada ULC. Dokumentaci smí Držitel licence reprodukovat pouze pro interní použití. Obsah tohoto dokumentu nesmí být měněn, upravován nebo měněn bez výslovného písemného souhlasu společnosti Changepoint Canada ULC. Changepoint Canada ULC může kdykoli změnit obsah zde uvedený, s upozorněním nebo bez něj.
Instalace rozhraní Changepoint API
O instalaci rozhraní Changepoint API
Changepoint API je k dispozici jako COM API, služba Windows Communication Foundation (WCF) a pro zpětnou kompatibilitu jako Web Služba vylepšení služeb (WSE). Informace o rozhraní Changepoint API naleznete v příručce Changepoint API Reference. Poznámky k upgradu, upozornění a známé problémy najdete v poznámkách k verzi v týmových složkách v Changepoint.
Upgrade rozhraní Changepoint API
Pokud upgradujete z předchozí verze Changepoint, použijte ovládací panel Windows k odinstalování předchozí verze Changepoint API a jejích komponent před instalací této verze.
Požadavky Changepoint API
Před instalací rozhraní Changepoint API musíte nainstalovat Changepoint. Požadavky na software najdete v matici kompatibility softwaru Changepoint, která je k dispozici v týmové složce Poznámky k vydání a opravy pro rok 2021 v Changepoint.
File konvence cesty
V celém tomto dokumentu jsou pro běžné cesty použity následující konvence:
- Kořenová cesta instalace Changepoint.
Výchozí cesta je:
C: Program Files (x86)ChangepointChangepoint - Kořenové umístění pro běžné nástroje Changepoint, jako je nástroj Login Settings.
Výchozí cesta je:
C: Program Files (x86) Běžné FilesChangepointChangepoint
Instalace rozhraní Changepoint API
- V kořenovém adresáři média rozhraní Changepoint API spusťte soubor setup.exe.
- Postupujte podle pokynů, dokud se nezobrazí obrazovka Select Features.
- Vyberte funkce, které chcete nainstalovat, a klepněte na tlačítko Další.
- Vyberte cílovou složku API, výchozí API a klikněte na Další.
Poznámka: Nástroj Changepoint Login Settings je nainstalován v LoginSettings, bez ohledu na cílovou složku, kterou určíte. - Pokud jste vybrali Web Služby API: a. Při výběru
a Web Objeví se obrazovka webu, vyberte a webweb, do kterého chcete přidat virtuální adresář, a potom klepněte na tlačítko Další.
b. Pokračujte kliknutím na Další. 6. Po dokončení instalace rozhraní API klepněte na tlačítko Dokončit.
Konfigurace rozhraní Changepoint API tak, aby bylo uvědomováno o mezipaměti
Chcete-li nakonfigurovat rozhraní Changepoint API tak, aby podporovalo mezipaměť, nahraďte hodnoty pro „cache. Heslo“ a „mezipaměť. Servery“ v CP Web SlužbyWeb.config file s hodnotami používanými v EnterpriseWeb.config file.
Povolení Web Vylepšení služeb (WSE)
- Upravit Web.config file pro web služby. Výchozí umístění je:
APICP Web SlužbyWeb.config - Najděte tři výskyty následujícího řádku komentáře:
< !– Pokud používáte, odkomentujte následující prvek Web Rozhraní API pro vylepšení služeb (WSE). Zanechte komentáře, pokud používáte služby WCF a neinstalujete Web Vylepšení služeb (WSE) –> - Odkomentujte prvek, který následuje za každou instancí řádku komentáře:
<název sekce=”microsoft.web.services2″ … >webSlužby>web.služby2>
Poznámka: ThewebSlužby> prvek, který má být odkomentován, je potomkemweb>.
Konfigurace protokolování pro Web Služby API
Musíte nastavit protokol file úrovně cesty a protokolu. Úrovně protokolu jsou kumulativní. Napřample, pokud zadáte úroveň 3, pak se zaprotokolují úrovně 1, 2 a 3. Výchozí úroveň protokolu je 8.
- Upravit web služby Web.config. Výchozí umístění je:
APICP Web SlužbyWeb.config - Nastavte protokolFileCesta. Výchozí hodnota je Protokoly APIAPI. 3. Nastavte LogLevel. Platné hodnoty jsou:
0 = Žádné protokolování
1 = Zdrojový objekt a metoda
2 = Chybová zpráva
3 = Vstupní parametry
4 = Vrácení
5 = Varování
8 = Kontrolní bod
Konfigurace ověřování virtuálního adresáře pro Web Služby API
Musíte povolit anonymní přístup a zakázat integrované ověřování systému Windows pro CPWebSlužba virtuálního adresáře v Internetové informační službě (IIS). Další informace naleznete v dokumentaci Microsoft IIS.
Konfigurace nastavení připojení k databázi pro Web Služby API
Pomocí nástroje Nastavení přihlášení zašifrujte nastavení připojení k databázi v Web Služby API Web.config file. Pro více informací vyhledejte “Konfigurace nastavení databázového připojení” v Changepoint Installation Guide.
Konfigurace ověřování pro Changepoint WCF Web Služby
Můžete nakonfigurovat ověřování aplikací a jednotné přihlášení (SSO) pro Changepoint WCF Web Služby.
Pomocí služby Secure Token Service (STS) jsou k dispozici následující možnosti implementace:
- SSO pomocí ISAPI SSL volitelné
- Jednotné přihlášení pomocí WS-Federation (ADFS 2.0) Vyžaduje SSL
Pokud je vyžadováno SSL, konfigurační skript zajistí jeho použití.
Konfigurační skripty pro ISAPI a ověřování aplikací mohou volitelně povolit SSL.
Konfigurace ověřování aplikací pro WCF Web Služby
Výchozí typ ověřování pro Changepoint WCF Web Služba je autentizace aplikací.
Pomocí postupů v této části:
- nakonfigurovat Changepoint WCF Web Služby pro použití ověřování aplikací pomocí SSL
- vrátit Changepoint WCF Web Služby pro autentizaci aplikace po implementaci jedné z implementací SSO
Nakonfigurujte PowerShell
- Otevřete výzvu prostředí Windows PowerShell.
- Upravte zásady provádění:
Set-ExecutionPolicy Unrestricted
Stage 1 Shromážděte konfigurační parametry
Určete hodnoty konfiguračních parametrů.
| Parametr | Popis |
| WebService_Path | Umístění Changepoint WCF Web Služby web aplikace files. Výchozí: \API\CP Web Služby |
| ServiceCertificate_ Jméno |
Název certifikátu, který bude použit k ověření služby klientům pomocí režimu zabezpečení zpráv. Výchozí: Název certifikátu „CN=ChangepointAPICertificate“. |
| vyžadují HTTPS | Vyžadovat HTTPS (pravda/nepravda) Výchozí: False. |
Stage 2 Spusťte konfigurační skripty
Použijte hodnoty pro konfigurační parametry k úpravě konfigurace webstránky.
- Otevřete výzvu PowerShellu.
Poznámka: Pokud má váš server povoleno Řízení uživatelských účtů, musíte otevřít výzvu PowerShellu pomocí zvýšených oprávnění správce. - Přejděte na CP web adresář konfigurace služby, výchozí:
ConfigurationCPWebServis - Spusťte ./Configuration_AppAuth.ps1
- Postupujte podle pokynů.
Konfigurace jednotného přihlášení (SSO) pro WCF Web Služby
Nakonfigurujte PowerShell
- Otevřete výzvu prostředí Windows PowerShell.
- Upravte zásady provádění:
Set-ExecutionPolicy Unrestricted
Konfigurace jednotného přihlášení pomocí ISAPI pro WCF Web Služby
Stage 1 Shromážděte konfigurační parametry
Určete hodnoty pro následující konfigurační parametry.
| Parametr | Popis |
| WebService_Path | Umístění Changepoint WCF Web Služby web aplikace files. Výchozí: \API\CP Web Služby |
| vyžadují HTTPS | Vyžadovat HTTPS (True/False). Výchozí: False. |
| Changepoint_RSA_ Cookie_Transform |
Název certifikátu, který používáte pro šifrování souborů cookie. Výchozí: Název certifikátu „CN=ChangepointAPICertificate“. |
| ServiceCertificate_Name | Zadejte název certifikátu, který bude použit k ověření služby klientům pomocí režimu zabezpečení zpráv. Výchozí: Název certifikátu „CN=ChangepointAPICertificate“. |
| SigningCertificate_Name | Zadejte název podpisového certifikátu. Toto je název certifikátu, který používáte k podepisování zpráv. Výchozí: Název certifikátu „CN=ChangepointAPICertificate“. |
| ISAPI_Mode | Režim ISAPI. Výchozí: NT |
| ISAPI_Header | Záhlaví používané v případě, že ISAPI_Mode je „HEADER“, napřample, prázdné. |
| ClaimType | Zadejte typ nároku SSO. Výchozí: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Spusťte konfigurační skripty
- Otevřete výzvu PowerShellu.
Poznámka: Pokud má váš server povoleno Řízení uživatelských účtů, musíte otevřít výzvu PowerShellu pomocí zvýšených oprávnění správce. - Přejděte na CP web adresář konfigurace služby, výchozí:
ConfigurationCPWebServis - Spusťte: ./Configuration_SSO_ISAPI.ps1
- Postupujte podle pokynů.
Konfigurace jednotného přihlášení pomocí WS-Federation (ADFS 2.0) pro WCF Web Služby
Stage 1 Shromážděte konfigurační parametry
Určete hodnoty konfiguračních parametrů v tabulce níže. Ujistěte se, že ADFS_Server_URI je v intranetové zóně prohlížeče koncového uživatele.
Poznámka: Ve výchozím nastavení je Changepoint nakonfigurován tak, aby automaticky aktualizoval veřejné klíče, které se používají k podepisování tokenů zabezpečení, pomocí publikovaného dokumentu metadat federace. V ADFS je to:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
V některých případech nemusí být možné dosáhnout serveru ADFS z bodu změny web server, takže po spuštění konfiguračního skriptu budete muset konfiguraci aktualizovat ručně. Podrobnosti naleznete v části „Ruční aktualizace veřejných klíčů“ na stránce 12.
| Parametr | Popis |
| WebService_Path | Umístění Changepoint WCF Web Služby web aplikace files. Výchozí: \API\CP Web Služby |
| WebService_URI | Identifikátor domény, který používáte pro Changepoint WCF Web Služby. Napřample., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_ Cookie_Transform | Název certifikátu, který používáte pro šifrování souborů cookie. Výchozí: Název certifikátu „CN=ChangepointApiCertificate“. |
| ServiceCertificate_Name | Název certifikátu, který bude použit k ověření služby klientům pomocí režimu zabezpečení zpráv. Výchozí: Název certifikátu „CN=ChangepointApiCertificate“. |
| SigningCertificate_Name | Název certifikátu, který používáte k podepisování zpráv. Výchozí: je použit název certifikátu „CN=ChangepointApiCertificate“. |
| ADFS_ FederationServiceName | Název služby Federation Service. Chcete-li získat název: Na serveru ADFS spusťte konzolu pro správu ADFS 2.0. •Z levé nabídky vyberte ADFS 2.0. •V podokně Akce vyberte Upravit vlastnosti služby Federation Service. Název služby Federation Service je na kartě Obecné. |
| ClaimType | Typ nároku SSO. Výchozí hodnota je: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Spusťte konfigurační skripty
Nakonfigurujte webstránky používající hodnoty pro konfigurační parametry.
- Otevřete výzvu PowerShellu.
Poznámka: Pokud má váš server povoleno Řízení uživatelských účtů, musíte otevřít výzvu PowerShellu pomocí zvýšených oprávnění správce. - Přejděte na bod změny web adresář konfigurace služby, výchozí: ConfigurationCPWebServis
- Spusťte: ./Configuration_SSO_ADFS.ps1
- Postupujte podle pokynů.
Stage 3 Vytvořte důvěru spoléhající strany
Vytvořte důvěryhodnou stranu předávající strany v konzole ADFS 2.0.
- Na serveru ADFS spusťte konzolu ADFS 2.0.
- Vyberte Akce > Přidat důvěryhodnost spoléhající strany.
- Klepněte na tlačítko Start.
- Vyberte Importovat data o spoléhající se straně publikovaná online nebo v místní síti.
- Zadejte adresu metadat federace a klepněte na tlačítko Další, napřampten:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Zadejte Zobrazovaný název, např. Changepoint WCF API, a klikněte na Další, Další, Další, potom Zavřít.
- Přidejte pravidlo nároku pro výše uvedenou závislou stranu Changepoint. Pro Changepoint je výchozí název pravidla reklamace „UPN“.
- Mapujte atribut LDAP „User-Principal-Name“ na typ odchozího nároku „* UPN“ nebo „UPN“.
Ruční aktualizace veřejných klíčů
Chcete-li získat miniaturu podpisu tokenu serveru ADFS
- Ze serveru ADFS spusťte konzolu pro správu ADFS 2.0.
- Vyberte položku Služba > Certifikáty a poklepejte na certifikát pro podepisování tokenu.
- Vyberte kartu Podrobnosti.
- Vyberte pole Miniatura.
- Chcete-li získat hodnotu otisku palce, odstraňte všechny mezery včetně první mezery.
Chcete-li aktualizovat Web.config file
- Upravte ADFS web.config. Výchozí umístění je:
EnterpriseRP-STS_ADFS - Pod element, najděte klíč ida:FederationMetadataLocation a vymažte jeho hodnotu:
- Pod , najít prvek a nahraďte jej následujícím: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust“/>
Testování připojení COM API
- Spusťte testovací sadu API. Výchozí umístění je:
Komponenty APIAPIApiTestKit.exe. - Klikněte na Připojovací řetězec > Šifrovač.
- V poli Řetězec připojení ve formátu prostého textu:
A. Nahraďte SERVERNAME a DATABASENAME informacemi o vaší databázi.
b. Nahraďte USERID a PASSWORD informacemi o vašem uživatelském účtu správce databáze.
C. Podle potřeby zadejte hodnotu časového limitu. - Klikněte na Šifrovat.
- Do pole Encrypted Connection String zkopírujte text.
- Zavřete dialogové okno.
- V nabídce API Test Kit klikněte na Připojení > Tester připojení COM API.
- Na kartě Aktuální verze vložte zašifrovaný připojovací řetězec do pole Připojovací řetězec.
- Do polí LoginId a Password zadejte přihlašovací ID a heslo pro váš účet Changepoint.
- V poli Loglevel (0-8) zadejte úroveň chybových informací, které mají být vráceny do protokolu COM API file pokud výsledek testu ukazuje problém s připojením.
0 = Žádné protokolování
1 = Zdrojový objekt a metoda
2 = Chybová zpráva
3 = Vstupní parametry
4 = Vrácení
5 = Varování
8 = Kontrolní bod
Výchozí hodnota je 8. - Klikněte na Připojit.
Pokud bylo připojení úspěšné, zobrazí se v poli Výsledek zpráva o úspěchu. Pokud se připojení nezdařilo, zkontrolujte protokol COM API file za chyby. Výchozí umístění protokolu file je APIAPILlogy.
Kontrola verze nainstalovaných komponent API
Chcete-li získat podrobnosti o nainstalovaných komponentách, včetně verze vydání a cesty, můžete použít obslužný program pro kontrolu verzí.
- Spusťte CPVersionChecker.exe. Výchozí cesta je: Komponenty APIAPI
- Klikněte na Číst.
Kontrola verze Web Služby API
- Spusťte Internet Explorer ze serveru, kde je Web Je nainstalováno rozhraní Services API a zadejte adresu:
http://localhost.port/CPWeb.Service/WSLogin.asmx kde port je číslo portu webmísto, kde jste nainstalovali CPWebSlužba virtuálního adresáře. - Na stránce WSLogin klikněte na odkaz GetVersion.
- Klikněte na Vyvolat.
Testování Web Připojení služby API
- Spusťte Internet Explorer ze serveru, kde je Web Je nainstalováno rozhraní Services API a zadejte adresu: http://localhost.port/CPWeb.Service/WSLogin.asmx kde port je číslo portu webmísto, kde jste nainstalovali CPWebSlužba virtuálního adresáře.
- Na stránce WSLogin klikněte na odkaz TestConnection.
- Klikněte na Vyvolat. 4. Ve výsledcích testu:
- Li je nepravda, testovací připojení bylo úspěšné.
- Li element je true, testovací připojení se nezdařilo. Více
informace o důvodech poruchy viz a prvky ve výsledcích testu a zkontrolujte protokoly API. Výchozí cesta k protokolům API je: Protokoly APIAPI
Nastavení Web Services API na jazykovém serveru
- Chcete-li nasadit Changepoint Web Services API na jazykovém serveru, musíte přidat nebo aktualizovat tag v Web Služby API web.config. Výchozí umístění Web.config file je: APICP Web SlužbyWeb.config
- Pokud tag již existuje, zajistěte, aby atributy kultury i uiCulture byly „en-US“.
- Pokud tag ještě neexistuje, přidejte následující , komentovat a prvky kweb> uzel:web>
Možnosti jazyka Visual Basic: Nastavením strict=”pravda” zakážete všechny konverze datových typů, kde může dojít ke ztrátě dat. Nastavením explicit=”true” vynutíte deklaraci všech proměnných. –> - Restartujte IIS.
Dokumenty / zdroje
 |
Software Changepoint API [pdf] Instalační průvodce API, software, API software |
