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 Инсталиране на API на Changepoint

2 Тестване на COM API връзката

3 Тестване на Web Връзка с API за услуги

4 Документи / Ресурси

4.1 Референции

5 Свързани публикации

Инсталиране на API на Changepoint

Относно инсталирането на API на Changepoint
API на Changepoint се предлага като COM API, услуга на Windows Communication Foundation (WCF) и, за обратна съвместимост, като Web Услуга за подобрения на услугите (WSE). За информация относно API на Changepoint вижте Справочник за API на Changepoint. За бележки за надстройка, предупреждения и известни проблеми вижте бележките по изданието в папките на екипа в Changepoint.
Надграждане на API на Changepoint
Ако надграждате от предишна версия на Changepoint, използвайте контролния панел на Windows, за да деинсталирате предишната версия на API на Changepoint и неговите компоненти, преди да инсталирате тази версия.
Changepoint API изисквания
Трябва да инсталирате Changepoint, преди да инсталирате API на Changepoint. За софтуерни изисквания вижте Матрицата за съвместимост на софтуера на Changepoint, която е налична в екипната папка Бележки по изданието и корекции за 2021 г. в Changepoint.
File конвенции за пътя
В този документ се използват следните конвенции за общи пътища:

Основният път на инсталацията на Changepoint.
Пътят по подразбиране е:
C: Програма Files (x86) Точка на промяна Точка на промяна
Основното местоположение за общи помощни програми на Changepoint, като например помощната програма за настройки за влизане.
Пътят по подразбиране е:
C: Програма Files (x86) Често срещано FilesChangepointChangepoint

Инсталиране на API на Changepoint

От основната медийна директория на Changepoint API изпълнете setup.exe.
Следвайте подканите, докато се появи екранът Избор на функции.
Изберете функциите, които искате да инсталирате, след което щракнете върху Напред.
Изберете целевата папка на API, по подразбиране API и щракнете върху Напред.
Забележка: Помощната програма Changepoint Login Settings е инсталирана в LoginSettings, независимо от целевата папка, която посочите.
Ако сте избрали Web API за услуги: a. Когато изберете Изберете
a Web Появява се екранът на сайта, изберете a webсайт, към който да добавите виртуалната директория, и след това щракнете върху Напред.
b. Щракнете върху Напред, за да продължите. 6. Когато инсталацията на API приключи, щракнете върху Готово.

Конфигуриране на API на Changepoint, за да се съобразява с кеша
За да конфигурирате API на Changepoint да поддържа кеша, заменете стойностите за „cache. Парола“ и „кеш. Сървъри” в CP 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.услуги2>
Забележка: ThewebServices> елементът, който трябва да бъде декоментиран, е дете наweb>.

Конфигуриране на регистриране за Web API за услуги
Трябва да зададете дневника file нива на пътя и регистрационния файл. Нивата на регистрационния файл са кумулативни. Напримерample, ако посочите ниво 3, тогава се записват нива 1, 2 и 3. Нивото на регистрационния файл по подразбиране е 8.

Редактирайте web услуги Web.config. Местоположението по подразбиране е:
APICP Web УслугиWeb.config
Задайте дневникаFileПътека. Стойността по подразбиране е APIAPILogs. 3. Задайте LogLevel. Валидните стойности са:
0 = Без регистриране
1 = Изходен обект и метод
2 = Съобщение за грешка
3 = Входни параметри
4 = Връщания
5 = Внимание
8 = Контролна точка

Конфигуриране на удостоверяване на виртуална директория за Web API за услуги
Трябва да активирате анонимния достъп и да деактивирате интегрираното Windows удостоверяване за CPWebСервизна виртуална директория в Internet Information Services (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 Услугите са удостоверяване на приложението.
Използвайте процедурите в този раздел, за да:

конфигурирайте точка на промяна 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.
Changepoint_RSA_ Cookie_Transform	Името на сертификата, който използвате за криптиране на бисквитки. По подразбиране: Името на сертификата „CN=ChangepointAPICertificate“.
ServiceCertificate_Name	Въведете името на сертификата, който ще се използва за удостоверяване на услугата за клиенти, използващи режима за защита на съобщенията. По подразбиране: Името на сертификата „CN=ChangepointAPICertificate“.
SigningCertificate_Name	Въведете името на сертификата за подписване. Това е името на сертификата, който използвате за подписване на съобщения. По подразбиране: Името на сертификата „CN=ChangepointAPICertificate“.
ISAPI_Mode	Режимът ISAPI. По подразбиране: NT
ISAPI_Header	Заглавката, използвана, когато ISAPI_Mode е „HEADER“, напрample, празно.
ClaimType	Въведете SSO Claim Type. По подразбиране: 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 е в интранет зоната на браузъра на крайния потребител.
Забележка: По подразбиране Changepoint е конфигуриран да актуализира автоматично публичните ключове, които се използват за подписване на маркери за сигурност, като използва публикувания документ с метаданни за федерация. В ADFS това е:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
В някои случаи може да не е възможно да се достигне до ADFS сървъра от Changepoint 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	Име на сертификата, който използвате за криптиране на бисквитки. По подразбиране: името на сертификата „CN=ChangepointApiCertificate“.
ServiceCertificate_Name	Име на сертификат, който ще се използва за удостоверяване на услугата за клиенти, използващи режима за защита на съобщенията. По подразбиране: името на сертификата „CN=ChangepointApiCertificate“.
SigningCertificate_Name	Име на сертификата, който използвате за подписване на съобщения. По подразбиране: използва се името на сертификата „CN=ChangepointApiCertificate“.
ADFS_ FederationServiceName	Име на услугата за федерация. За да получите името: От ADFS сървъра стартирайте конзолата за управление на ADFS 2.0. • Изберете ADFS 2.0 от лявото меню. •От панела за действие изберете Редактиране на свойствата на услугата за федерация. Името на услугата за федерация е в раздела Общи.
ClaimType	Тип иск за SSO. По подразбиране е: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Изпълнение на конфигурационни скриптове
Конфигурирайте webсайтове, използващи стойностите за конфигурационните параметри.

Отворете подкана на PowerShell.
Забележка: Ако вашият сървър има активиран контрол на потребителските акаунти, трябва да отворите подканата на PowerShell, като използвате повишени администраторски права.
Навигирайте до точката на промяна web директория за конфигурация на услугата, по подразбиране: КонфигурацияCPWebОбслужване
Изпълнете: ./Configuration_SSO_ADFS.ps1
Следвайте инструкциите.

Stagд 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“.

Ръчно актуализиране на публични ключове
За да получите Thumbprint за подписване на ADFS Server Token

От ADFS сървъра стартирайте конзолата за управление ADFS 2.0.
Изберете Услуга > Сертификати и щракнете двукратно върху сертификата за подписване на токен.
Изберете раздела Подробности.
Изберете полето Thumbprint.
За да получите стойността на отпечатъка, премахнете всички интервали, включително първия интервал.

За да актуализирате 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. Местоположението по подразбиране е:
APIAPI ComponentsApiTestKit.exe.
Щракнете върху Низ за връзка > Шифровач.
В полето низ за връзки с обикновен текст:
а. Заменете SERVERNAME и DATABASENAME с информацията за вашата база данни.
b. Заменете USERID и PASSWORD с информацията за потребителския акаунт на вашия администратор на база данни.
° С. Въведете стойността на времето за изчакване, ако е необходимо.
Щракнете върху Шифроване.
В полето Encrypted Connection String копирайте текста.
Затворете диалоговия прозорец.
В менюто API Test Kit щракнете върху Connection > COM API Connection Tester.
В раздела Текуща версия поставете шифрования низ за връзка в полето Низ за връзка.
В полетата LoginId и Password въведете ID за вход и парола за вашия акаунт в Changepoint.
В полето Loglevel (0-8) посочете нивото на информация за грешка, което да бъде върнато в регистрационния файл на COM API file ако резултатът от теста показва проблем с връзката.
0 = Без регистриране
1 = Изходен обект и метод
2 = Съобщение за грешка
3 = Входни параметри
4 = Връщания
5 = Внимание
8 = Контролна точка
По подразбиране е 8.
Щракнете върху Свързване.
Ако връзката е успешна, в полето за резултат се показва съобщение за успех. Ако връзката е неуспешна, проверете регистрационния файл на COM API file за грешки. Местоположението по подразбиране на дневника file е APIAPILogs.

Проверка на версията на инсталираните API компоненти
Можете да използвате помощната програма за проверка на версията, за да получите подробности за инсталираните компоненти, включително версията на изданието и пътя.

Стартирайте CPVersionChecker.exe. Пътят по подразбиране е: APIAPI компоненти
Щракнете върху Прочетете.

Проверка на версията на Web API за услуги

Стартирайте Internet Explorer от сървъра, където е Web API за услуги е инсталиран и въведете адреса:
http://localhost.port/CPWeb.Service/WSLogin.asmx където порт е номерът на порта на webсайт, където сте инсталирали CPWebОбслужваща виртуална директория.
На страницата WSLogin щракнете върху връзката GetVersion.
Щракнете върху Извикване.

Тестване на Web Връзка с API за услуги

Стартирайте Internet Explorer от сървъра, където е Web API за услуги е инсталиран и въведете адреса: http://localhost.port/CPWeb.Service/WSLogin.asmx където порт е номерът на порта на webсайт, където сте инсталирали CPWebОбслужваща виртуална директория.
На страницата WSLogin щракнете върху връзката TestConnection.
Щракнете върху Извикване. 4. В резултатите от теста:

Ако елементът е false, тестовата връзка е успешна.
Ако елементът е верен, тестовата връзка е неуспешна. За още
информация за причините за повредата вижте и елементи в резултатите от теста и проверете регистрационните файлове на API. Пътят по подразбиране до регистрационните файлове на API е: APIAPILogs

Настройване на 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.