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 бағдарламасының алдыңғы шығарылымын жаңартып жатсаңыз, осы нұсқаны орнату алдында Changepoint API және оның құрамдастарының алдыңғы нұсқасын жою үшін Windows басқару тақтасын пайдаланыңыз.
Changepoint API талаптары
Changepoint API орнату алдында Changepoint орнату керек. Бағдарламалық құрал талаптарын өзгерту үшін Changepoint ішіндегі 2021 шығарылым жазбалары мен патчтар командасы қалтасында қолжетімді Changepoint бағдарламалық құралының үйлесімділік матрицасын қараңыз.
File жол конвенциялары
Осы құжатта жалпы жолдар үшін келесі конвенциялар пайдаланылады:

Changepoint орнатуының түбірлік жолы.
Әдепкі жол:
C: Бағдарлама Files (x86)Өзгеріс нүктесіӨзгеріс нүктесі

Кіру параметрлері қызметтік бағдарламасы сияқты жалпы Changepoint утилиталарының түбірлік орны.
Әдепкі жол:
C: Бағдарлама Files (x86) ортақ FilesChangepointChangepoint

Changepoint API орнату

Changepoint API медиасының түбірлік каталогынан setup.exe файлын іске қосыңыз.
Мүмкіндіктерді таңдау экраны пайда болғанша нұсқауларды орындаңыз.
Орнатқыңыз келетін мүмкіндіктерді таңдап, «Келесі» түймесін басыңыз.

API тағайындау қалтасын таңдаңыз, әдепкі API және «Келесі» түймесін басыңыз.
Ескерту: Changepoint Login Settings утилитасы орнатылған Сіз көрсеткен мақсатты қалтаға қарамастан LoginSettings.
таңдасаңыз Web Services API: a. Таңдалған кезде
a Web Сайт экраны пайда болады, a таңдаңыз webвиртуалды каталогты қосу үшін сайтты таңдаңыз, содан кейін «Келесі» түймесін басыңыз.
б. Жалғастыру үшін Келесі түймесін басыңыз. 6. API орнату аяқталғанда, Аяқтау түймесін басыңыз.

Changepoint API кэшті білу үшін конфигурациялануда
Changepoint API интерфейсін кэшті білетін етіп конфигурациялау үшін «кэш. Құпия сөз» және «кэш. CP ішіндегі серверлер» пернелері Web ҚызметтерWeb.config file Кәсіпорында пайдаланылатын мәндерменWeb.config file.
Қосылуда Web Қызметтерді жақсарту (WSE)

өңдеу Web.config file үшін web қызметтер. Әдепкі орын:
APICP Web ҚызметтерWeb.config

Келесі түсініктеме жолының үш данасын табыңыз:
< !– Пайдаланатын болсаңыз, келесі элементті алып тастаңыз Web Service Enhancements (WSE) API. WCF қызметтерін пайдалансаңыз және орнатылмай жатсаңыз, пікірлер қалдырыңыз Web Қызмет жақсартулары (WSE) –>
Түсініктеме жолының әрбір данасынан кейінгі элементті алып тастаңыз:
<section name=”microsoft.web.services2″ … >webҚызметтер>web.қызметтер2>
Ескерту: ThewebҚызметтер> түсініктемесіз қалдырылатын элемент еншілес болып табыладыweb>.

үшін журнал жүргізу конфигурациялануда Web Services API
Журналды орнату керек file жол және журнал деңгейлері. Журнал деңгейлері жинақталған. Мысалыample, егер сіз 3-деңгейді көрсетсеңіз, онда 1, 2 және 3 деңгейлер журналға жазылады. Әдепкі журнал деңгейі 8 болып табылады.

өңдеу web қызметтер Web.config. Әдепкі орын:
APICP Web ҚызметтерWeb.config

Журналды орнатыңызFileЖол. Әдепкі мән APIAPILlogs. 3. LogLevel параметрін орнатыңыз. Жарамды мәндер:
0 = Тіркеу жоқ
1 = Бастапқы нысан және әдіс
2 = Қате туралы хабар
3 = Енгізу параметрлері
4 = қайтарады
5 = Ескерту
8 = Бақылау нүктесі

үшін виртуалды каталог аутентификациясын конфигурациялау Web Services API
Анонимді қатынасты қосу және CP үшін біріктірілген Windows аутентификациясын өшіру керекWebInternet Information Services (IIS) қызметіндегі виртуалды каталог. Қосымша ақпарат алу үшін Microsoft IIS құжаттамасын қараңыз.
үшін дерекқорға қосылу параметрлерін конфигурациялау Web Services API
Жүйеге кіру параметрлері утилитасын файлдағы дерекқорға қосылу параметрлерін шифрлау үшін пайдаланыңыз Web Services API Web.config file. Қосымша ақпарат алу үшін Changepoint орнату нұсқаулығында «Дерекқорға қосылу параметрлерін конфигурациялау» деп іздеңіз.
Changepoint WCF үшін аутентификацияны теңшеу Web Қызметтер
Changepoint WCF үшін қолданбаның аутентификациясын және бір рет кіруді (SSO) теңшей аласыз Web Қызметтер.
Келесі іске асыру опциялары Secure Token Service (STS) арқылы қол жетімді:

Қосымша ISAPI SSL пайдаланатын SSO
WS-Federation (ADFS 2.0) SSL қолданатын SSO қажет

SSL қажет болса, конфигурация сценарийі оның пайдаланылуын қамтамасыз етеді.
ISAPI және қолданбаның аутентификациясы үшін конфигурация сценарийлері міндетті түрде SSL мүмкіндігін қоса алады.
WCF үшін қолданбаның аутентификациясын теңшеу Web Қызметтер
Changepoint WCF үшін әдепкі аутентификация түрі Web Қызметтер қолданбаның аутентификациясы болып табылады.
Осы бөлімдегі процедураларды мыналар үшін пайдаланыңыз:

Changepoint WCF теңшеу Web SSL көмегімен қолданбаның аутентификациясын пайдалану қызметтері

WCF өзгерту нүктесін қайтару Web SSO енгізулерінің бірін жүзеге асырғаннан кейін қолданбаның аутентификациясына арналған қызметтер

PowerShell конфигурациялау

Windows PowerShell шақыруын ашыңыз.
Орындау саясатын өзгерту:
Орындау саясаты шектеусіз

Stage 1 Конфигурация параметрлерін жинаңыз
Конфигурация параметрлерінің мәндерін анықтаңыз.

Параметр	Сипаттама
WebҚызмет_жолы	WCF өзгерту нүктесінің орны Web Қызметтер web қолданба files. Әдепкі: \API\CP Web Қызметтер
Қызмет сертификаты_ Аты	Хабарлама қауіпсіздік режимін пайдаланып клиенттерге қызметтің түпнұсқалығын растау үшін пайдаланылатын сертификат атауы. Әдепкі: “CN=ChangepointAPICertificate” сертификат атауы.
HTTPS қажет	HTTPS талап ету (шын/жалған) Әдепкі: False.

Stage 2 Конфигурация сценарийлерін орындау
конфигурациясын өзгерту үшін конфигурация параметрлерінің мәндерін пайдаланыңыз webсайттар.

PowerShell шақыруын ашыңыз.
Ескерту: Серверде Пайдаланушы тіркелгісін басқару мүмкіндігі қосылған болса, жоғарылатылған әкімші рұқсаттарын пайдаланып PowerShell шақыруын ашу керек.

CP-ге өтіңіз web қызмет конфигурациясының каталогы, әдепкі:
ConfigurationCPWebҚызмет
./Configuration_AppAuth.ps1 орындаңыз
Нұсқауларды орындаңыз.

WCF үшін бір рет кіруді (SSO) теңшеу Web Қызметтер
PowerShell конфигурациялау

Windows PowerShell шақыруын ашыңыз.
Орындау саясатын өзгерту:
Орындау саясаты шектеусіз

WCF үшін ISAPI арқылы SSO конфигурациялау Web Қызметтер
Stage 1 Конфигурация параметрлерін жинаңыз
Келесі конфигурация параметрлері үшін мәндерді анықтаңыз.

Параметр	Сипаттама
WebҚызмет_жолы	Changepoint WCF орны Web Қызметтер web қолданба files. Әдепкі: \API\CP Web Қызметтер
HTTPS қажет	HTTPS талап етеді (шын/жалған). Әдепкі: False.
Changepoint_RSA_ Cookie_Transform	Cookie шифрлау үшін пайдаланатын сертификаттың атауы. Әдепкі: “CN=ChangepointAPICertificate” сертификат атауы.
Сертификат_атауы	Хабарлама қауіпсіздік режимін пайдаланып клиенттерге қызметтің аутентификациясы үшін пайдаланылатын сертификат атауын енгізіңіз. Әдепкі: “CN=ChangepointAPICertificate” сертификат атауы.
Қол қою куәлігі_атауы	Қол қою сертификатының атын енгізіңіз. Бұл хабарларға қол қою үшін пайдаланылатын сертификаттың атауы. Әдепкі: “CN=ChangepointAPICertificate” сертификат атауы.
ISAPI_Mode	ISAPI режимі. Әдепкі: NT
ISAPI_тақырыбы	ISAPI_Mode "HEADER" болғанда пайдаланылатын тақырып, мысалыampле, бос.
Шағым түрі	SSO шағым түрін енгізіңіз. Әдепкі: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Конфигурация сценарийлерін орындау

PowerShell шақыруын ашыңыз.
Ескерту: Серверде Пайдаланушы тіркелгісін басқару мүмкіндігі қосылған болса, жоғарылатылған әкімші рұқсаттарын пайдаланып PowerShell шақыруын ашу керек.

CP-ге өтіңіз web қызмет конфигурациясының каталогы, әдепкі:
ConfigurationCPWebҚызмет
Орындау: ./Configuration_SSO_ISAPI.ps1
Нұсқауларды орындаңыз.

WCF үшін WS-Federation (ADFS 2.0) арқылы SSO конфигурациялау Web Қызметтер
Stage 1 Конфигурация параметрлерін жинаңыз
Төмендегі кестедегі конфигурация параметрлерінің мәндерін анықтаңыз. ADFS_Server_URI соңғы пайдаланушы шолғышының интранет аймағында екеніне көз жеткізіңіз.
Ескерту: Әдепкі бойынша Changepoint жарияланған федерация метадеректер құжатын пайдалану арқылы қауіпсіздік таңбалауыштарына қол қою үшін пайдаланылатын жалпы кілттерді автоматты түрде жаңарту үшін конфигурацияланған. ADFS жүйесінде бұл:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Кейбір жағдайларда Changepoint арқылы ADFS серверіне жету мүмкін болмауы мүмкін web сервер, сондықтан конфигурация сценарийін іске қосқаннан кейін конфигурацияны қолмен жаңартуға тура келеді. Толық ақпаратты 12-беттегі “Ашық кілттерді қолмен жаңарту” бөлімінен қараңыз.

Параметр	Сипаттама
WebҚызмет_жолы	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» сертификат атауы.
Сертификат_атауы	Хабарлама қауіпсіздік режимін пайдаланып клиенттерге қызметтің түпнұсқалығын растау үшін пайдаланылатын сертификат атауы. Әдепкі: «CN=ChangepointApiCertificate» сертификат атауы.
Қол қою куәлігі_атауы	Хабарларға қол қою үшін пайдаланылатын сертификаттың атауы. Әдепкі: «CN=ChangepointApiCertificate» сертификат атауы пайдаланылады.
ADFS_ FederationServiceName	Федерация қызметінің атауы. Атауды алу үшін: ADFS серверінен ADFS 2.0 басқару консолін іске қосыңыз. •Сол жақ мәзірден ADFS 2.0 таңдаңыз. •Әрекеттер тақтасынан Федерация қызметінің сипаттарын өңдеу опциясын таңдаңыз. Федерация қызметінің атауы Жалпы қойындысында орналасқан.
Шағым түрі	SSO шағым түрі. Әдепкі: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Конфигурация сценарийлерін орындау
конфигурациялаңыз webконфигурация параметрлерінің мәндерін пайдаланатын сайттар.

PowerShell шақыруын ашыңыз.
Ескерту: Серверде Пайдаланушы тіркелгісін басқару мүмкіндігі қосылған болса, жоғарылатылған әкімші рұқсаттарын пайдаланып PowerShell шақыруын ашу керек.

Өзгерту нүктесіне өтіңіз web қызмет конфигурациясының каталогы, әдепкі: ConfigurationCPWebҚызмет
Орындау: ./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 төлсипатын «* 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 сынақ жинағын іске қосыңыз. Әдепкі орын:
APIAPI ComponentsApiTestKit.exe.
Қосылым жолы > Шифрлаушы түймесін басыңыз.
Қарапайым мәтіндік қосылымдар жолы өрісінде:
а. SERVERNAME және DATABASENAME дегенді дерекқор ақпаратымен ауыстырыңыз.
б. Пайдаланушы идентификаторы мен ҚҰПИЯ сөзді дерекқор әкімшісінің пайдаланушы тіркелгісінің ақпаратымен ауыстырыңыз.
в. Қажет болса, күту уақыты мәнін енгізіңіз.
Шифрлау түймесін басыңыз.
Шифрланған қосылым жолы өрісінде мәтінді көшіріңіз.
Диалогтық терезені жабыңыз.
API сынақ жинағы мәзірінде Қосылым > COM API қосылымын тексеру құралы түймешігін басыңыз.
Ағымдағы нұсқа қойындысында шифрланған қосылым жолын Қосылым жолы өрісіне қойыңыз.
LoginId және Password өрістерінде Changepoint тіркелгіңіз үшін логин идентификаторы мен құпия сөзді енгізіңіз.
Loglevel (0-8) өрісінде COM API журналында қайтарылатын қате ақпаратының деңгейін көрсетіңіз file егер сынақ нәтижесі қосылымда ақаулықты көрсетсе.
0 = Тіркеу жоқ
1 = Бастапқы нысан және әдіс
2 = Қате туралы хабар
3 = Енгізу параметрлері
4 = қайтарады
5 = Ескерту
8 = Бақылау нүктесі
Әдепкі мәні - 8.
Қосылу түймесін басыңыз.
Қосылым сәтті болса, нәтиже өрісінде сәтті хабар көрсетіледі. Қосылым сәтсіз болса, COM API журналын тексеріңіз file қателер үшін. Журналдың әдепкі орны file болып табылады APIAPILlogs.

Орнатылған API құрамдастарының нұсқасын тексеру
Орнатылған құрамдас бөліктер, соның ішінде шығарылым нұсқасы мен жол туралы мәліметтерді алу үшін нұсқа тексеру құралын пайдалануға болады.

CPVersionChecker.exe файлын іске қосыңыз. Әдепкі жол: APIAPI құрамдастары
Оқу түймесін басыңыз.

нұсқасын тексеру Web Services API

серверден Internet Explorer бағдарламасын іске қосыңыз Web Services API орнатылды және мекенжайды енгізіңіз:
http://localhost.port/CPWeb.Service/WSLogin.asmx мұндағы порт - порттың нөмірі webCP орнатқан сайтWebҚызметтік виртуалды каталог.
WSLogin бетінде GetVersion сілтемесін басыңыз.
Шақыру түймесін басыңыз.

сынау Web Services API қосылымы

серверден Internet Explorer бағдарламасын іске қосыңыз Web Services API орнатылды және мекенжайды енгізіңіз: http://localhost.port/CPWeb.Service/WSLogin.asmx мұндағы порт - порттың нөмірі webCP орнатқан сайтWebҚызметтік виртуалды каталог.
WSLogin бетінде TestConnection сілтемесін басыңыз.
Шақыру түймесін басыңыз. 4. Тест нәтижелерінде:

Егер элемент жалған, сынақ қосылымы сәтті аяқталды.

Егер элемент шын, сынақ қосылымы сәтсіз аяқталды. Қосымша ақпарат алу үшін
ақаулық себептері туралы ақпаратты қараңыз және сынақ нәтижелеріндегі элементтерді және API журналдарын тексеріңіз. API журналдарының әдепкі жолы: APIAPILlogs

орнату Web Тіл серверіндегі API қызметтері

Өзгеріс нүктесін қолдану үшін Web Тіл серверіндегі API Services үшін қосу немесе жаңарту қажет tag ішінде Web Services API web.config. әдепкі орны Web.config file бұл: APICP Web ҚызметтерWeb.config

Егер tag бұрыннан бар болса, мәдениет пен uiCulture атрибуттарының «en-US» екеніне көз жеткізіңіз.
Егер tag бұрыннан жоқ, келесіні қосыңыз , түсініктеме және элементтерінеweb> түйін:web>
Visual Basic опциялары: деректер жоғалуы мүмкін барлық деректер түрі түрлендірулеріне жол бермеу үшін strict=”true” мәнін орнатыңыз. Барлық айнымалыларды күштеп жариялау үшін explicit=“true” мәнін орнатыңыз. –>
IIS қайта іске қосыңыз.