Кіраўніцтва па ўстаноўцы праграмнага забеспячэння Changepoint API

Кіраўніцтва па ўстаноўцы API
Даведачны дапаможнік
Кропка змены 2021

© 2021 Changepoint Canada ULC. Усе правы абаронены. ПРАВЫ ЎРАДА ЗША - выкарыстанне, капіраванне або раскрыццё інфармацыі ўрадам ЗША падлягае абмежаванням, выкладзеным у ліцэнзійным пагадненні Changepoint Canada ULC і ў адпаведнасці з DFARS 227.7202-1(a) і 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (кастрычнік 1988), FAR 12.212(a) (1995), FAR 52.227-19 або FAR 52.227-14 (ALT III), у залежнасці ад неабходнасці. Гэты прадукт змяшчае канфідэнцыйную інфармацыю і камерцыйныя сакрэты Changepoint Canada ULC. Разгалашэнне забаронена без папярэдняга пісьмовага дазволу Changepoint Canada ULC. Выкарыстанне гэтага прадукта рэгулюецца ўмовамі ліцэнзійнага пагаднення карыстальніка з Changepoint Canada ULC. Дакументацыя можа быць прайграна Ліцэнзіятам толькі для ўнутранага выкарыстання. Змест гэтага дакумента не можа быць зменены, мадыфікаваны або зменены без відавочнай пісьмовай згоды Changepoint Canada ULC. Changepoint Canada ULC можа змяніць змесціва, указанае тут, у любы час, з паведамленнем або без яго.

Змест схаваць

1 Ўстаноўка Changepoint API

2 Тэставанне злучэння COM API

3 Тэставанне Web Падключэнне Services API

4 Дакументы / Рэсурсы

4.1 Спасылкі

5 Падобныя паведамленні

Ўстаноўка Changepoint API

Аб усталяванні Changepoint API
Changepoint API даступны як COM API, служба Windows Communication Foundation (WCF) і, для зваротнай сумяшчальнасці, як Web Сэрвіс Services Enhancements (WSE). Для атрымання інфармацыі аб Changepoint API глядзіце Даведнік па Changepoint API. Заўвагі аб абнаўленні, засцярогі і вядомыя праблемы глядзіце ў Заўвагах да выпуску ў папках каманды ў Changepoint.
Абнаўленне Changepoint API
Калі вы абнаўляецеся з папярэдняга выпуску Changepoint, выкарыстоўвайце панэль кіравання Windows, каб выдаліць папярэднюю версію API Changepoint і яе кампаненты перад устаноўкай гэтай версіі.
Патрабаванні да API пункту змены
Вы павінны ўсталяваць Changepoint перад устаноўкай Changepoint API. Каб даведацца пра патрабаванні да праграмнага забеспячэння, азнаёмцеся з матрыцай сумяшчальнасці праграмнага забеспячэння Changepoint, якая даступная ў тэчцы каманды "Нататкі аб выпуску і патчы" 2021 года ў Changepoint.
File шлях канв
У гэтым дакуменце для агульных шляхоў выкарыстоўваюцца наступныя пагадненні:

Каранёвы шлях ўстаноўкі Changepoint.
Шлях па змаўчанні:
C: Праграма Files (x86) Кропка змены Кропка змены
Каранёвае размяшчэнне для звычайных утыліт Changepoint, такіх як утыліта Login Settings.
Шлях па змаўчанні:
C: Праграма Files (x86) Агульны FilesChangepointChangepoint

Ўстаноўка Changepoint API

З каранёвага каталога мультымедыя Changepoint API запусціце setup.exe.
Выконвайце падказкі, пакуль не з'явіцца экран выбару функцый.
Выберыце функцыі, якія вы хочаце ўсталяваць, затым націсніце «Далей».
Выберыце папку прызначэння API па змаўчанні API і націсніце Далей.
Заўвага: Утыліта Changepoint Login Settings усталявана ў LoginSettings, незалежна ад папкі прызначэння, якую вы ўказваеце.
Калі вы выбралі Web API паслуг: a. Калі кнопка Выбраць
a Web З'явіцца экран сайта, выберыце a webсайт, каб дадаць віртуальны каталог, а затым націсніце кнопку Далей.
б. Націсніце "Далей", каб працягнуць. 6. Пасля завяршэння ўстаноўкі API націсніце «Гатова».

Канфігурацыя Changepoint API для захавання кэша
Каб наладзіць API Changepoint на кэш-памяць, заменіце значэнні для «cache. Пароль» і «Кэш. Серверы» ключы ў КП Web ПаслугіWeb.config file са значэннямі, якія выкарыстоўваюцца на прадпрыемствеWeb.config file.
Уключэнне Web Паляпшэнні паслуг (WSE)

Рэдагаваць Web.config file для web паслугі. Размяшчэнне па змаўчанні:
APICP Web ПаслугіWeb.config
Знайдзіце тры асобнікі наступнага радка каментара:
< !– Раскаментуйце наступны элемент, калі вы выкарыстоўваеце Web API паляпшэння паслуг (WSE). Пакіньце каментарыі, калі выкарыстоўваеце службы WCF і не ўсталёўваеце Web Паляпшэнні паслуг (WSE) –>
Раскаментуйце элемент, які ідзе пасля кожнага асобніка радка каментара:
<section name=”microsoft.web.services2″ … >webПаслугі>web.services2>
Заўвага: ThewebЭлемент Services>, які трэба раскаментаваць, з'яўляецца даччынымweb>.

Налада вядзення часопіса для Web API паслуг
Вы павінны ўсталяваць часопіс file шляхі і ўзроўні часопіса. Ўзроўні часопіса з'яўляюцца накапляльнымі. Напрыкладample, калі вы ўказваеце ўзровень 3, то ўзроўні 1, 2 і 3 будуць запісвацца. Стандартны ўзровень журнала - 8.

Рэдагаваць web паслугі Web.config. Размяшчэнне па змаўчанні:
APICP Web ПаслугіWeb.config
Усталюйце часопісFileшлях. Значэнне па змаўчанні Журналы APIAPIL. 3. Усталюйце LogLevel. Дапушчальныя значэнні:
0 = Без рэгістрацыі
1 = Зыходны аб'ект і метад
2 = Паведамленне пра памылку
3 = Уваходныя параметры
4 = Вяртанне
5 = Папярэджанне
8 = кантрольна-прапускны пункт

Налада аўтэнтыфікацыі віртуальнага каталога для Web API паслуг
Вы павінны ўключыць ананімны доступ і адключыць інтэграваную аўтэнтыфікацыю Windows для CPWebСлужба віртуальнага каталога ў Інфармацыйных службах Інтэрнэту (IIS). Для атрымання дадатковай інфармацыі глядзіце дакументацыю Microsoft IIS.
Налада параметраў злучэння з базай дадзеных для Web API паслуг
Выкарыстоўвайце ўтыліту Налады ўваходу, каб зашыфраваць параметры злучэння з базай дадзеных у Web API паслуг Web.config file. Для атрымання дадатковай інфармацыі знайдзіце «Наладжванне налад падключэння да базы дадзеных» у Кіраўніцтве па ўстаноўцы Changepoint.
Налада аўтэнтыфікацыі для Changepoint WCF Web Паслугі
Вы можаце наладзіць аўтэнтыфікацыю прыкладання і адзіны ўваход (SSO) для Changepoint WCF Web Паслугі.
Наступныя варыянты рэалізацыі даступныя з дапамогай Secure Token Service (STS):

SSO з выкарыстаннем ISAPI SSL неабавязкова
SSO з выкарыстаннем WS-Federation (ADFS 2.0) Патрабуецца SSL

Калі патрабуецца SSL, скрыпт канфігурацыі забяспечвае яго выкарыстанне.
Скрыпты канфігурацыі для ISAPI і аўтэнтыфікацыі прыкладання могуць дадаткова ўключыць SSL.
Налада аўтэнтыфікацыі прыкладання для WCF Web Паслугі
Тып аўтэнтыфікацыі па змаўчанні для Changepoint WCF Web Сэрвіс - гэта аўтэнтыфікацыя прыкладанняў.
Выкарыстоўвайце працэдуры ў гэтым раздзеле, каб:

наладзіць Changepoint WCF Web Паслугі для выкарыстання аўтэнтыфікацыі прыкладанняў з SSL
вярнуць кропку змены WCF Web Паслугі аўтэнтыфікацыі прыкладанняў пасля ўкаранення адной з рэалізацый SSO

Наладзьце PowerShell

Адкрыйце запыт Windows PowerShell.
Змяніць палітыку выканання:
Set-ExecutionPolicy Unrestricted

Stage 1 Збярыце параметры канфігурацыі
Вызначце значэнні параметраў канфігурацыі.

Параметр	Апісанне
WebService_Path	Размяшчэнне кропкі змены WCF Web Паслугі web прымяненне files. Па змаўчанні: \API\CP Web Паслугі
ServiceCertificate_ Імя	Імя сертыфіката, якое будзе выкарыстоўвацца для аўтэнтыфікацыі службы для кліентаў з выкарыстаннем рэжыму бяспекі паведамленняў. Па змаўчанні: назва сертыфіката «CN=ChangepointAPICertificate».
патрабуецца HTTPS	Патрабаваць HTTPS (праўда/хлусня) Па змаўчанні: False.

Stage 2 Выкананне сцэнарыяў канфігурацыі
Выкарыстоўвайце значэнні для параметраў канфігурацыі, каб змяніць канфігурацыю webсайты.

Адкрыйце запыт PowerShell.
Заўвага: Калі на вашым серверы ўключаны Кантроль уліковых запісаў карыстальнікаў, вы павінны адкрыць запыт PowerShell, выкарыстоўваючы павышаныя правы адміністратара.
Перайдзіце да CP web каталог канфігурацыі службы, па змаўчанні:
КанфігурацыяCPWebАбслугоўванне
Выканаць ./Configuration_AppAuth.ps1
Выконвайце падказкі.

Налада адзінага ўваходу (SSO) для WCF Web Паслугі
Наладзьце PowerShell

Адкрыйце запыт Windows PowerShell.
Змяніць палітыку выканання:
Set-ExecutionPolicy Unrestricted

Налада SSO з дапамогай ISAPI для WCF Web Паслугі
Stage 1 Збярыце параметры канфігурацыі
Вызначце значэнні для наступных параметраў канфігурацыі.

Параметр	Апісанне
WebService_Path	Размяшчэнне кропкі змены WCF Web Паслугі web прымяненне files. Па змаўчанні: \API\CP Web Паслугі
патрабуецца HTTPS	Патрабаваць HTTPS (праўда/хлусня). Па змаўчанні: False.
Кропка змены_RSA_ Cookie_Transform	Назва сертыфіката, які вы выкарыстоўваеце для шыфравання файлаў cookie. Па змаўчанні: назва сертыфіката «CN=ChangepointAPICertificate».
ServiceCertificate_Name	Увядзіце назву сертыфіката, які будзе выкарыстоўвацца для аўтэнтыфікацыі службы для кліентаў у рэжыме бяспекі паведамленняў. Па змаўчанні: назва сертыфіката «CN=ChangepointAPICertificate».
SigningCertificate_Name	Увядзіце назву сертыфіката подпісу. Гэта назва сертыфіката, які вы выкарыстоўваеце для подпісу паведамленняў. Па змаўчанні: назва сертыфіката «CN=ChangepointAPICertificate».
Рэжым ISAPI	Рэжым ISAPI. Па змаўчанні: NT
ISAPI_Загаловак	Загаловак, які выкарыстоўваецца, калі ISAPI_Mode з'яўляецца "HEADER", напрыкладampле, пусты.
ClaimType	Увядзіце тып прэтэнзіі SSO. Па змаўчанні: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Выкананне сцэнарыяў канфігурацыі

Адкрыйце запыт PowerShell.
Заўвага: Калі на вашым серверы ўключаны Кантроль уліковых запісаў карыстальнікаў, вы павінны адкрыць запыт PowerShell, выкарыстоўваючы павышаныя правы адміністратара.
Перайдзіце да CP web каталог канфігурацыі службы, па змаўчанні:
КанфігурацыяCPWebАбслугоўванне
Выканаць: ./Configuration_SSO_ISAPI.ps1
Выконвайце падказкі.

Налада SSO з дапамогай WS-Federation (ADFS 2.0) для WCF Web Паслугі
Stage 1 Збярыце параметры канфігурацыі
Вызначце значэнні параметраў канфігурацыі ў табліцы ніжэй. Пераканайцеся, што ADFS_Server_URI знаходзіцца ў зоне Intranet браўзера канчатковага карыстальніка.
Заўвага: Па змаўчанні Changepoint настроены на аўтаматычнае абнаўленне адкрытых ключоў, якія выкарыстоўваюцца для подпісу токенаў бяспекі, з дапамогай апублікаванага дакумента метаданых федэрацыі. У ADFS гэта:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
У некаторых выпадках можа быць немагчыма дасягнуць сервера ADFS з пункту змены web сервера, так што вам прыйдзецца ўручную абнавіць канфігурацыю пасля запуску скрыпту канфігурацыі. Падрабязнасці глядзіце ў раздзеле «Абнаўленне адкрытых ключоў уручную» на старонцы 12.

Параметр	Апісанне
WebService_Path	Размяшчэнне кропкі змены WCF Web Паслугі web прымяненне fileс. Па змаўчанні: \API\CP Web Паслугі
WebService_URI	Ідэнтыфікатар дамена, які вы выкарыстоўваеце для Changepoint WCF Web Паслугі. Напрыкладampле., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Назва сертыфіката, які вы выкарыстоўваеце для шыфравання файлаў cookie. Па змаўчанні: імя сертыфіката «CN=ChangepointApiCertificate».
ServiceCertificate_Name	Імя сертыфіката, якое будзе выкарыстоўвацца для аўтэнтыфікацыі службы для кліентаў з выкарыстаннем рэжыму бяспекі паведамленняў. Па змаўчанні: імя сертыфіката «CN=ChangepointApiCertificate».
SigningCertificate_Name	Назва сертыфіката, які вы выкарыстоўваеце для подпісу паведамленняў. Па змаўчанні: выкарыстоўваецца назва сертыфіката "CN=ChangepointApiCertificate".
ADFS_ FederationServiceName	Назва службы федэрацыі. Каб атрымаць імя: На серверы ADFS запусціце кансоль кіравання ADFS 2.0. • Абярыце ADFS 2.0 з меню злева. • На панэлі дзеянняў выберыце Edit Federation Service Properties. Назва службы Федэрацыі знаходзіцца на ўкладцы Агульныя.
ClaimType	Тып прэтэнзіі SSO. Па змаўчанні: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Выкананне сцэнарыяў канфігурацыі
Наладзьце webсайты з выкарыстаннем значэнняў для параметраў канфігурацыі.

Адкрыйце запыт PowerShell.
Заўвага: Калі на вашым серверы ўключаны Кантроль уліковых запісаў карыстальнікаў, вы павінны адкрыць запыт PowerShell, выкарыстоўваючы павышаныя правы адміністратара.
Перайдзіце да пункту змены web каталог канфігурацыі службы, па змаўчанні: КанфігурацыяCPWebАбслугоўванне
Выканаць: ./Configuration_SSO_ADFS.ps1
Выконвайце падказкі.

Stage 3 Стварыце давер даверанага боку
Стварыце давер правяраючага боку ў кансолі ADFS 2.0.

На серверы ADFS запусціце кансоль ADFS 2.0.
Абярыце Дзеянне > Дадаць давер правяраючага боку.
Націсніце Пуск.
Абярыце "Імпартаваць даныя пра давяраючы бок", апублікаваныя ў інтэрнэце або лакальнай сетцы.
Увядзіце адрас метаданых Федэрацыі, а затым націсніце Далей, напрыкладampль:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
Увядзіце адлюстраванае імя, напрыклад Changepoint WCF API, і націсніце "Далей", "Далей", "Далей", затым "Зачыніць".
Дадайце правіла прэтэнзіі для вышэйзгаданага Правяраючага боку ў кропцы змены. Для Changepoint назва правіла прэтэнзіі па змаўчанні - "UPN".
Суадносіце атрыбут LDAP «User-Principal-Name» з тыпам выходнай прэтэнзіі «* UPN» або «UPN».

Абнаўленне адкрытых ключоў уручную
Каб атрымаць адбітак подпісу маркера сервера ADFS

На серверы ADFS запусціце кансоль кіравання ADFS 2.0.
Абярыце Сэрвіс > Сертыфікаты і двойчы пстрыкніце сертыфікат подпісу маркера.
Выберыце ўкладку «Падрабязнасці».
Выберыце поле «Адбітак вялікага пальца».
Каб атрымаць значэнне адбітка вялікага пальца, выдаліце ўсе прабелы, уключаючы першы прабел.

Каб абнавіць Web.config file

Адрэдагуйце ADFS web.config. Размяшчэнне па змаўчанні:
EnterpriseRP-STS_ADFS
Пад знайдзіце ключ ida:FederationMetadataLocation і ачысціце яго значэнне:
Пад , знайсці і заменіце яго наступным: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Тэставанне злучэння COM API

Запусціце набор тэстаў API. Размяшчэнне па змаўчанні:
Кампаненты APIAPIApiTestKit.exe.
Націсніце Радок злучэння > Шыфравальнік.
У радку злучэнняў звычайнага тэксту:
а. Заменіце SERVERNAME і DATABASENAME інфармацыяй аб вашай базе дадзеных.
б. Заменіце USERID і PASSWORD інфармацыяй аб уліковым запісе адміністратара базы дадзеных.
в. Пры неабходнасці ўвядзіце значэнне тайм-аўту.
Націсніце Шыфраваць.
Скапіруйце тэкст у полі "Зашыфраваны радок злучэння".
Зачыніце дыялогавае акно.
У меню API Test Kit націсніце Connection > COM API Connection Tester.
На ўкладцы "Бягучая версія" ўстаўце зашыфраваны радок злучэння ў поле "Радок злучэння".
У палях LoginId і Password увядзіце ідэнтыфікатар і пароль для вашага ўліковага запісу Changepoint.
У полі Loglevel (0-8) укажыце ўзровень інфармацыі пра памылку, якая будзе вяртацца ў журнале COM API file калі вынік тэсту паказвае праблему з падключэннем.
0 = Без рэгістрацыі
1 = Зыходны аб'ект і метад
2 = Паведамленне пра памылку
3 = Уваходныя параметры
4 = Вяртанне
5 = Папярэджанне
8 = кантрольна-прапускны пункт
Па змаўчанні - 8.
Націсніце Connect.
Калі злучэнне прайшло паспяхова, у полі "Вынік" адлюстроўваецца паведамленне аб паспяховым выкананні. Калі злучэнне не атрымалася, праверце журнал COM API file за памылкі. Размяшчэнне часопіса па змаўчанні file ёсць Журналы APIAPIL.

Праверка версіі ўсталяваных кампанентаў API
Вы можаце выкарыстоўваць утыліту праверкі версій, каб атрымаць падрабязную інфармацыю аб усталяваных кампанентах, уключаючы версію выпуску і шлях.

Запусціце CPVersionChecker.exe. Шлях па змаўчанні: Кампаненты APIAPI
Націсніце Чытаць.

Праверка версіі Web API паслуг

Запусціце Internet Explorer з сервера, дзе знаходзіцца Web Services API усталяваны, і ўвядзіце адрас:
http://localhost.port/CPWeb.Service/WSLogin.asmx дзе port - гэта нумар порта webсайт, дзе вы ўсталявалі CPWebСлужба віртуальнага каталога.
На старонцы WSLogin націсніце спасылку GetVersion.
Націсніце Выклік.

Тэставанне Web Падключэнне Services API

Запусціце Internet Explorer з сервера, дзе знаходзіцца Web Services API усталяваны, і ўвядзіце адрас: http://localhost.port/CPWeb.Service/WSLogin.asmx дзе port - гэта нумар порта webсайт, дзе вы ўсталявалі CPWebСлужба віртуальнага каталога.
На старонцы WSLogin націсніце спасылку TestConnection.
Націсніце Выклік. 4. У выніках тэсту:

Калі элемент ілжывы, тэставае злучэнне ўдалося.
Калі элемент праўдзівы, тэставае злучэнне не атрымалася. Для большага
інфармацыю аб прычынах збою гл і элементы ў выніках тэставання і праверце журналы API. Стандартны шлях да журналаў API: Журналы APIAPIL

Настройка Web API паслуг на моўным серверы

Каб разгарнуць Changepoint Web Службы API на моўным серверы, вы павінны дадаць або абнавіць tag у Web API паслуг web.config. Размяшчэнне па змаўчанні Web.config file гэта: APICP Web ПаслугіWeb.config
Калі tag ужо існуе, пераканайцеся, што культура і uiCulture атрыбуты «en-US».
Калі tag яшчэ не існуе, дадайце наступнае , каментар і элементаў да стweb> вузел:web>
Параметры Visual Basic: усталюйце strict=”true”, каб забараніць усе пераўтварэнні тыпаў даных, у якіх можа адбыцца страта даных. Усталюйце explicit=”true” для прымусовага аб’яўлення ўсіх зменных. –>
Перазапусціце IIS.