Przewodnik instalacji interfejsu API
Przewodnik referencyjny
Punkt zmian 2021
© 2021 Changepoint Canada ULC Wszelkie prawa zastrzeżone. PRAWA RZĄDU USA — Używanie, powielanie lub ujawnianie przez rząd USA podlega ograniczeniom określonym w umowie licencyjnej Changepoint Canada ULC oraz zgodnie z postanowieniami DFARS 227.7202-1(a) i 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (październik 1988), FAR 12.212(a) (1995), FAR 52.227-19 lub FAR 52.227-14 (ALT III), stosownie do przypadku. Ten produkt zawiera poufne informacje i tajemnice handlowe firmy Changepoint Canada ULC. Ujawnianie informacji jest zabronione bez uprzedniej wyraźnej pisemnej zgody firmy Changepoint Canada ULC. Korzystanie z tego produktu podlega warunkom Umowy licencyjnej użytkownika z firmą Changepoint Canada ULC. Dokumentacja może być powielana przez Licencjobiorcę wyłącznie do użytku wewnętrznego. Treść tego dokumentu nie może być zmieniana, modyfikowana ani zmieniana bez wyraźnej pisemnej zgody Changepoint Canada ULC. Changepoint Canada ULC może zmienić treść określoną w niniejszym dokumencie w dowolnym momencie, za powiadomieniem lub bez.
Instalowanie interfejsu API Changepoint
Informacje o instalowaniu interfejsu API Changepoint
Interfejs API Changepoint jest dostępny jako interfejs API COM, usługa Windows Communication Foundation (WCF) oraz, w celu zapewnienia kompatybilności wstecznej, jako Web Usługa Usprawnienia Usług (GPW). Aby uzyskać informacje na temat interfejsu API Changepoint, zobacz Dokumentacja interfejsu API Changepoint. Aby zapoznać się z uwagami dotyczącymi aktualizacji, zastrzeżeniami i znanymi problemami, zobacz Informacje o wersji w folderach zespołu w Changepoint.
Aktualizacja interfejsu API Changepoint
Jeśli aktualizujesz poprzednią wersję Changepoint, użyj Panelu sterowania systemu Windows, aby odinstalować poprzednią wersję API Changepoint i jego składników przed zainstalowaniem tej wersji.
Wymagania API punktu zmiany
Przed zainstalowaniem interfejsu API Changepoint należy zainstalować Changepoint. Aby zapoznać się z wymaganiami dotyczącymi oprogramowania, zobacz Matrycę zgodności oprogramowania Changepoint, która jest dostępna w folderze zespołu Uwagi do wydania i poprawki na rok 2021 w Changepoint.
File konwencje ścieżki
W całym dokumencie stosowane są następujące konwencje dotyczące typowych ścieżek:
- Ścieżka główna instalacji Changepoint.
Domyślna ścieżka to:
C:Program Files (x86)Punkt zmianyPunkt zmiany - Lokalizacja główna popularnych narzędzi Changepoint, takich jak narzędzie Ustawienia logowania.
Domyślna ścieżka to:
C:Program Files (x86) wspólne FilesPunkt zmianyPunkt zmiany
Instalowanie interfejsu API Changepoint
- Z katalogu głównego multimediów API Changepoint uruchom plik setup.exe.
- Postępuj zgodnie z instrukcjami, aż pojawi się ekran Wybierz funkcje.
- Wybierz funkcje, które chcesz zainstalować, a następnie kliknij Dalej.
- Wybierz folder docelowy interfejsu API, domyślnie API i kliknij Dalej.
Notatka: Narzędzie Changepoint Login Settings jest zainstalowane w LoginSettings, niezależnie od określonego folderu docelowego. - Jeśli wybrałeś Web API usług: Kiedy wybierz
a Web Pojawi się ekran witryny, wybierz a website, do której chcesz dodać katalog wirtualny, a następnie kliknij Dalej.
B. Naciśnij dalej by kontynuować. 6. Po zakończeniu instalacji API kliknij Zakończ.
Konfigurowanie interfejsu API Changepoint tak, aby obsługiwał pamięć podręczną
Aby skonfigurować interfejs API Changepoint tak, aby obsługiwał pamięć podręczną, zamień wartości w pliku „cache. Hasło” i „pamięć podręczna. Serwery” w CP Web UsługiWeb.konfiguracja file z wartościami stosowanymi w PrzedsiębiorstwieWeb.konfiguracja file.
Włączanie Web Ulepszenia usług (GPW)
- Edytuj Web.konfiguracja file Do web usługi. Domyślna lokalizacja to:
APICP Web UsługiWeb.konfiguracja - Znajdź trzy wystąpienia następującej linii komentarza:
< !– Odkomentuj następujący element, jeśli go używasz Web API udoskonaleń usług (GPW). Zostaw komentarz, jeśli korzystasz z usług WCF i nie instalujesz Web Udoskonalenia Usług (GPW) –> - Odkomentuj element następujący po każdym wystąpieniu linii komentarza:
<section name=”microsoft.web.usługi2″… >webUsługi>web.usługi2>
Notatka: TenwebServices>, którego nie należy komentować, jest elementem podrzędnymweb>.
Konfigurowanie rejestrowania dla Web Usługi API
Musisz ustawić dziennik file ścieżki i poziomy dziennika. Poziomy rejestrowania kumulują się. Na przykładample, jeśli określisz poziom 3, rejestrowane będą poziomy 1, 2 i 3. Domyślny poziom rejestrowania to 8.
- Edytuj web Usługi Web.konfiguracja Domyślna lokalizacja to:
APICP Web UsługiWeb.konfiguracja - Ustaw dziennikFileŚcieżka. Wartość domyślna to Dzienniki APIAPIL. 3. Ustaw poziom dziennika. Prawidłowe wartości to:
0 = Brak rejestrowania
1 = Obiekt źródłowy i metoda
2 = Komunikat o błędzie
3 = Parametry wejściowe
4 = Zwroty
5 = Ostrzeżenie
8 = Punkt kontrolny
Konfigurowanie uwierzytelniania katalogu wirtualnego dla Web Usługi API
Należy włączyć dostęp anonimowy i wyłączyć zintegrowane uwierzytelnianie systemu Windows dla punktu kontrolnegoWebUsługa katalogu wirtualnego w Internetowych usługach informacyjnych (IIS). Aby uzyskać więcej informacji, zobacz dokumentację Microsoft IIS.
Konfigurowanie ustawień połączenia z bazą danych dla Web Usługi API
Użyj narzędzia Ustawienia logowania, aby zaszyfrować ustawienia połączenia z bazą danych w pliku Web Usługi API Web.konfiguracja file. Aby uzyskać więcej informacji, wyszukaj „Konfigurowanie ustawień połączenia z bazą danych” w Podręczniku instalacji Changepoint.
Konfigurowanie uwierzytelniania dla Changepoint WCF Web Usługi
Można skonfigurować uwierzytelnianie aplikacji i logowanie jednokrotne (SSO) dla Changepoint WCF Web Usługi.
Przy użyciu usługi Secure Token Service (STS) dostępne są następujące opcje implementacji:
- Opcjonalne logowanie jednokrotne przy użyciu protokołu ISAPI SSL
- Wymagane jest logowanie jednokrotne przy użyciu protokołu WS-Federation (ADFS 2.0) SSL
Jeśli wymagany jest protokół SSL, skrypt konfiguracyjny zapewnia jego użycie.
Skrypty konfiguracyjne dla ISAPI i uwierzytelniania aplikacji mogą opcjonalnie włączyć SSL.
Konfigurowanie uwierzytelniania aplikacji dla WCF Web Usługi
Domyślny typ uwierzytelniania dla Changepoint WCF Web Usługi to uwierzytelnianie aplikacji.
Skorzystaj z procedur opisanych w tej sekcji, aby:
- skonfiguruj punkt zmiany WCF Web Usługi umożliwiające uwierzytelnianie aplikacji za pomocą protokołu SSL
- przywróć punkt zmiany WCF Web Usługi uwierzytelniania aplikacji po wdrożeniu jednego z wdrożeń SSO
Skonfiguruj PowerShell
- Otwórz monit programu Windows PowerShell.
- Zmodyfikuj politykę wykonania:
Ustaw-Zasady-Wykonywania Nieograniczone
Stage 1 Zbierz parametry konfiguracyjne
Określ wartości parametrów konfiguracyjnych.
| Parametr | Opis |
| WebŚcieżka_usługi | Lokalizacja punktu zmiany WCF Web Usługi web aplikacja files. Domyślny: \API\CP Web Usługi |
| Certyfikat usługi_ Nazwa |
Nazwa certyfikatu, który będzie używany do uwierzytelniania usługi na klientach korzystających z trybu zabezpieczeń wiadomości. Wartość domyślna: nazwa certyfikatu „CN=ChangepointAPICertificate”. |
| wymagają protokołu HTTPS | Wymagaj protokołu HTTPS (prawda/fałsz) Wartość domyślna: Fałsz. |
Stage 2 Wykonaj skrypty konfiguracyjne
Użyj wartości parametrów konfiguracyjnych, aby zmodyfikować konfigurację pliku webwitryny.
- Otwórz monit programu PowerShell.
Notatka: Jeśli Twój serwer ma włączoną Kontrolę konta użytkownika, musisz otworzyć monit programu PowerShell, korzystając z podwyższonych uprawnień administratora. - Przejdź do punktu kontrolnego web katalog konfiguracyjny usługi, domyślnie:
KonfiguracjaCPWebPraca - Wykonaj ./Configuration_AppAuth.ps1
- Postępuj zgodnie z instrukcjami.
Konfigurowanie logowania jednokrotnego (SSO) dla WCF Web Usługi
Skonfiguruj PowerShell
- Otwórz monit programu Windows PowerShell.
- Zmodyfikuj politykę wykonania:
Ustaw-Zasady-Wykonywania Nieograniczone
Konfigurowanie logowania jednokrotnego przy użyciu protokołu ISAPI dla WCF Web Usługi
Stage 1 Zbierz parametry konfiguracyjne
Określ wartości następujących parametrów konfiguracyjnych.
| Parametr | Opis |
| WebŚcieżka_usługi | Lokalizacja punktu zmiany WCF Web Usługi web aplikacja files. Domyślny: \API\CP Web Usługi |
| wymagają protokołu HTTPS | Wymagaj protokołu HTTPS (prawda/fałsz). Wartość domyślna: Fałsz. |
| Punkt zmiany_RSA_ Cookie_Transform |
Nazwa certyfikatu używanego do szyfrowania plików cookie. Wartość domyślna: nazwa certyfikatu „CN=ChangepointAPICertificate”. |
| Nazwa_certyfikatu usługi | Wprowadź nazwę certyfikatu, który będzie używany do uwierzytelniania usługi na klientach korzystających z trybu zabezpieczeń wiadomości. Wartość domyślna: nazwa certyfikatu „CN=ChangepointAPICertificate”. |
| SigningCertificate_Name | Wprowadź nazwę certyfikatu podpisywania. Jest to nazwa certyfikatu, którego używasz do podpisywania wiadomości. Wartość domyślna: nazwa certyfikatu „CN=ChangepointAPICertificate”. |
| Tryb ISAPI | Tryb ISAPI. Wartość domyślna: NT |
| Nagłówek ISAPI_ | Nagłówek używany, gdy tryb ISAPI_Mode to „HEADER”, npample, puste. |
| Typ roszczenia | Wprowadź typ wniosku SSO. Domyślny: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Wykonaj skrypty konfiguracyjne
- Otwórz monit programu PowerShell.
Notatka: Jeśli Twój serwer ma włączoną Kontrolę konta użytkownika, musisz otworzyć monit programu PowerShell, korzystając z podwyższonych uprawnień administratora. - Przejdź do punktu kontrolnego web katalog konfiguracyjny usługi, domyślnie:
KonfiguracjaCPWebPraca - Wykonaj: ./Configuration_SSO_ISAPI.ps1
- Postępuj zgodnie z instrukcjami.
Konfigurowanie logowania jednokrotnego przy użyciu usługi WS-Federation (ADFS 2.0) dla usługi WCF Web Usługi
Stage 1 Zbierz parametry konfiguracyjne
Określ wartości parametrów konfiguracyjnych w poniższej tabeli. Upewnij się, że ADFS_Server_URI znajduje się w strefie intranetowej przeglądarki użytkownika końcowego.
Notatka: Domyślnie program Changepoint jest skonfigurowany do automatycznego aktualizowania kluczy publicznych używanych do podpisywania tokenów zabezpieczających przy użyciu opublikowanego dokumentu metadanych federacji. W ADFS jest to:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
W niektórych przypadkach połączenie z serwerem ADFS z punktu zmiany może nie być możliwe web serwer, dlatego po uruchomieniu skryptu konfiguracyjnego konieczne będzie ręczne zaktualizowanie konfiguracji. Aby uzyskać szczegółowe informacje, zobacz „Ręczne aktualizowanie kluczy publicznych” na stronie 12.
| Parametr | Opis |
| WebŚcieżka_usługi | Lokalizacja punktu zmiany WCF Web Usługi web aplikacja fileS. Domyślny: \API\CP Web Usługi |
| WebUsługa_URI | Identyfikator domeny używany dla Changepoint WCF Web Usługi. Na przykładample., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_ Cookie_Transform | Nazwa certyfikatu, którego używasz do szyfrowania plików cookie. Wartość domyślna: nazwa certyfikatu „CN=ChangepointApiCertificate”. |
| Nazwa_certyfikatu usługi | Nazwa certyfikatu, który będzie używany do uwierzytelniania usługi na klientach korzystających z trybu zabezpieczeń wiadomości. Wartość domyślna: nazwa certyfikatu „CN=ChangepointApiCertificate”. |
| SigningCertificate_Name | Nazwa certyfikatu używanego do podpisywania wiadomości. Wartość domyślna: używana jest nazwa certyfikatu „CN=ChangepointApiCertificate”. |
| Nazwa usługi federacyjnej ADFS_ | Nazwa usługi federacyjnej. Aby uzyskać nazwę: Na serwerze ADFS uruchom konsolę zarządzania ADFS 2.0. •Wybierz ADFS 2.0 z lewego menu. • W okienku akcji wybierz opcję Edytuj właściwości usługi federacyjnej. Nazwa usługi federacyjnej znajduje się na karcie Ogólne. |
| Typ roszczenia | Typ roszczenia SSO. Wartość domyślna to: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Wykonaj skrypty konfiguracyjne
Skonfiguruj webwitryn korzystających z wartości parametrów konfiguracyjnych.
- Otwórz monit programu PowerShell.
Notatka: Jeśli Twój serwer ma włączoną Kontrolę konta użytkownika, musisz otworzyć monit programu PowerShell, korzystając z podwyższonych uprawnień administratora. - Przejdź do punktu zmiany web katalog konfiguracyjny usługi, domyślnie: KonfiguracjaCPWebPraca
- Wykonaj: ./Configuration_SSO_ADFS.ps1
- Postępuj zgodnie z instrukcjami.
Stage 3 Utwórz zaufanie strony uzależnionej
Utwórz zaufanie strony uzależnionej w konsoli ADFS 2.0.
- Na serwerze ADFS uruchom konsolę ADFS 2.0.
- Wybierz opcję Akcja > Dodaj zaufanie strony uzależnionej.
- Kliknij Start.
- Wybierz opcję Importuj dane o jednostce uzależnionej opublikowane online lub w sieci lokalnej.
- Wprowadź adres metadanych Federacji, a następnie kliknij przycisk Dalej, npampna:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Wprowadź nazwę wyświetlaną, np. interfejs API Changepoint WCF, i kliknij Dalej, Dalej, Dalej, a następnie Zamknij.
- Dodaj regułę roszczenia dla powyższej strony zależnej punktu zmiany. W przypadku Changepoint domyślna nazwa reguły roszczenia to „UPN”.
- Zamapuj atrybut LDAP „Nazwa użytkownika-głównego” na typ roszczenia wychodzącego „* UPN” lub „UPN”.
Ręczna aktualizacja kluczy publicznych
Aby uzyskać odcisk palca podpisywania tokenu serwera ADFS
- Na serwerze ADFS Uruchom konsolę zarządzania ADFS 2.0.
- Wybierz opcję Usługa > Certyfikaty i kliknij dwukrotnie certyfikat podpisywania tokenu.
- Wybierz kartę Szczegóły.
- Wybierz pole Odcisk palca.
- Aby uzyskać wartość odcisku palca, usuń wszystkie spacje, łącznie z pierwszą spacją.
Aby zaktualizować Web.konfiguracja file
- Edytuj ADFS web.konfiguracja Domyślna lokalizacja to:
EnterpriseRP-STS_ADFS - Pod element, znajdź klucz ida:FederationMetadataLocation i wyczyść jego wartość:
- Pod , znaleźć element i zastąp go następującym: https://ADFS_Federation.ServiceName/adfs/services/trust„>https://ADFS_Federation.ServiceName/adfs/services/trust” />
Testowanie połączenia COM API
- Uruchom zestaw testowy interfejsu API. Domyślna lokalizacja to:
Komponenty APIAPIApiTestKit.exe. - Kliknij Parametry połączenia > Program szyfrujący.
- W polu Ciąg połączeń w postaci zwykłego tekstu:
A. Zastąp NAZWĘ SERWERA i NAZWĘBAZY DANYCH informacjami o bazie danych.
B. Zastąp USERID i PASSWORD informacjami o koncie użytkownika administratora bazy danych.
C. W razie potrzeby wprowadź wartość limitu czasu. - Kliknij Szyfruj.
- W polu Parametry szyfrowanego połączenia skopiuj tekst.
- Zamknij okno dialogowe.
- W menu Zestaw testowy interfejsu API kliknij opcję Połączenie > Tester połączenia interfejsu API COM.
- Na karcie Bieżąca wersja wklej zaszyfrowany ciąg połączenia w polu Parametry połączenia.
- W polach LoginId i Password wprowadź identyfikator logowania i hasło do swojego konta Changepoint.
- W polu Poziom dziennika (0-8) określ poziom informacji o błędach, które mają być zwracane w dzienniku COM API file jeśli wynik testu wykaże problem z połączeniem.
0 = Brak rejestrowania
1 = Obiekt źródłowy i metoda
2 = Komunikat o błędzie
3 = Parametry wejściowe
4 = Zwroty
5 = Ostrzeżenie
8 = Punkt kontrolny
Wartość domyślna to 8. - Kliknij Połącz.
Jeśli połączenie powiodło się, w polu Wynik zostanie wyświetlony komunikat o powodzeniu. Jeśli połączenie nie powiodło się, sprawdź dziennik COM API file za błędy. Domyślna lokalizacja dziennika file Jest Dzienniki APIAPIL.
Sprawdzanie wersji zainstalowanych komponentów API
Możesz użyć narzędzia sprawdzania wersji, aby uzyskać szczegółowe informacje na temat zainstalowanych komponentów, w tym wersję wydania i ścieżkę.
- Uruchom plik CPVersionChecker.exe. Domyślna ścieżka to: Składniki APIAPI
- Kliknij Czytaj.
Sprawdzanie wersji Web Usługi API
- Uruchom przeglądarkę Internet Explorer z serwera, na którym znajduje się plik Web Services API jest zainstalowane i wprowadź adres:
http://localhost.port/CPWeb.Service/WSLogin.asmx gdzie port jest numerem portu webmiejscu, w którym zainstalowałeś CPWebUsługa katalogu wirtualnego. - Na stronie WSLogin kliknij łącze GetVersion.
- Kliknij Wywołaj.
Testowanie Web Połączenie API usług
- Uruchom przeglądarkę Internet Explorer z serwera, na którym znajduje się plik Web Services API jest zainstalowane i wprowadź adres: http://localhost.port/CPWeb.Service/WSLogin.asmx gdzie port jest numerem portu webmiejscu, w którym zainstalowałeś CPWebUsługa katalogu wirtualnego.
- Na stronie WSLogin kliknij łącze TestConnection.
- Kliknij Wywołaj. 4. W wynikach testu:
- Jeśli element ma wartość false, połączenie testowe powiodło się.
- Jeśli element ma wartość true, połączenie testowe nie powiodło się. Aby uzyskać więcej
Informacje o przyczynach awarii znajdują się w pkt I elementy w wynikach testu i sprawdź logi API. Domyślna ścieżka do dzienników API to: Dzienniki APIAPIL
Konfigurowanie Web Usługi API na serwerze językowym
- Aby wdrożyć punkt zmiany Web Services API na serwerze językowym, należy dodać lub zaktualizować plik tag w Web Usługi API web.konfiguracja Domyślna lokalizacja Web.konfiguracja file Jest: APICP Web UsługiWeb.konfiguracja
- Jeśli tag już istnieje, upewnij się, że atrybuty kultura i uiCulture mają wartość „en-US”.
- Jeśli tag jeszcze nie istnieje, dodaj następujący wpis , komentarz i elementy doweb> węzeł:web>
Opcje Visual Basic: Ustaw strict="true", aby uniemożliwić wszystkie konwersje typów danych, w przypadku których może nastąpić utrata danych. Ustaw jawne=”true”, aby wymusić deklarację wszystkich zmiennych. –> - Uruchom ponownie usługi IIS.
Dokumenty / Zasoby
 |
Oprogramowanie API punktu zmiany [plik PDF] Instrukcja instalacji API, oprogramowanie, oprogramowanie API |
