API орнотуу колдонмосу
Reference Guide
Changepoint 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) (OCT 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 Кызматтардын API туташуусу
4 Документтер / Ресурстар
4.1 Шилтемелер
5 Окшош билдирүүлөр

Changepoint API орнотуу

Changepoint API орнотуу жөнүндө
Changepoint API COM API, Windows Communication Foundation (WCF) кызматы жана артка карай шайкештик үчүн Web Кызматтарды жакшыртуу (WSE) кызматы. Changepoint API жөнүндө маалымат алуу үчүн, Changepoint API шилтемесин караңыз. Жаңыртуу эскертмелери, эскертүүлөр жана белгилүү маселелер үчүн Changepoint'тин команда папкаларында Release Notes караңыз.
Changepoint API жаңыртылууда
Эгер сиз Changepoint'тин мурунку релизинен жаңыртып жатсаңыз, бул версияны орнотуудан мурун Changepoint API'нин мурунку версиясын жана анын компоненттерин өчүрүү үчүн Windows Башкаруу панелин колдонуңуз.
Changepoint API талаптары
Changepoint API орнотуудан мурун Changepoint орнотушуңуз керек. Программалык камсыздоо талаптарын көрүү үчүн, Changepoint программасындагы 2021-жылдын Release Notes жана Patches командасы папкасында жеткиликтүү болгон Changepoint программалык шайкештик матрицасын караңыз.
File жол конвенциялары
Бул документте жалпы жолдор үчүн төмөнкү конвенциялар колдонулат:

  • Changepoint орнотуусунун түпкү жолу.
    Демейки жол:
    C: Программа Files (x86)ChangepointChangepoint
  • Кирүү Орнотуулар утилитасы сыяктуу жалпы Changepoint утилиталарынын түпкү жайгашкан жери.
    Демейки жол:
    C: Программа Files (x86) Жалпы FilesChangepointChangepoint

Changepoint API орнотуу

  1. Changepoint API медиа түпкү каталогунан setup.exe файлын иштетиңиз.
  2. Функцияларды тандоо экраны пайда болгонго чейин көрсөтмөлөрдү аткарыңыз.
  3. Орноткуңуз келген функцияларды тандап, андан кийин Кийинки баскычын басыңыз.
  4. API көздөгөн папканы тандаңыз, демейки API жана Кийинки чыкылдатыңыз.
    Эскертүү: Changepoint Login Settings утилитасы орнотулган LoginSettings, сиз көрсөткөн көздөгөн папкага карабастан.
  5. Эгер сиз тандаган болсоңуз Web Services API: a. Тандоо болгондо
    a Web Сайт экраны пайда болот, а тандаңыз webсайтка виртуалдык каталогду кошуп, андан кийин Кийинки баскычын басыңыз.
    б. Улантуу үчүн Кийинки баскычын басыңыз. 6. API орнотуу аяктагандан кийин, Finish баскычын чыкылдатыңыз.

Changepoint API кэштен кабардар болуу үчүн конфигурацияланууда
Changepoint API'син кэш-билгидей кылып конфигурациялоо үчүн, "кэштин маанилерин алмаштырыңыз. Сырсөз» жана «кэш. КПдагы серверлер” баскычтары Web КызматтарWeb.config file Ишканада колдонулган баалуулуктар мененWeb.config file.
Иштетүү Web Кызматтарды өркүндөтүү (WSE)

  1. түзөтүү Web.config file үчүн web кызматтар. Демейки жайгашкан жер:
    APICP Web КызматтарWeb.config
  2. Төмөнкү комментарий сабынын үч учурун табыңыз:
    < !– Эгер сиз колдонуп жатсаңыз, төмөнкү элементти комментарийден чыгарыңыз Web Service Enhancements (WSE) API. WCF кызматтарын колдонуп, орнотулбай жатсаңыз, комментарий калтырыңыз Web Кызматты өркүндөтүү (WSE) –>
  3. Комментарий сабынын ар бир инстанциясынан кийинки элементти комментарийден чыгарыңыз:
    <section name=”microsoft.web.services2″ … >webКызматтар>web.кызматтар2>
    Эскертүү: ThewebКызматтар> комментарияланбай турган элемент - булweb>.

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

  1. түзөтүү web кызматтар Web.config. Демейки жайгашкан жер:
    APICP Web КызматтарWeb.config
  2. Журналды орнотуңузFileЖол. демейки маани болуп саналат APIAPILlogs. 3. LogLevel коюңуз. Жарактуу баалуулуктар:
    0 = Каттоо жок
    1 = Булак объекти жана ыкмасы
    2 = Ката кабары
    3 = Киргизүү параметрлери
    4 = Кайтаруу
    5 = Эскертүү
    8 = Текшерүү пункту

үчүн виртуалдык каталогдун аутентификациясын конфигурациялоо Web Services API
Сиз анонимдүү кирүү мүмкүнчүлүгүн иштетип, CP үчүн Integrated Windows аутентификациясын өчүрүшүңүз керекWebИнтернет маалымат кызматтарындагы (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 менен колдонмонун аутентификациясын колдонуу кызматтары
  • Changepoint WCF кайтаруу Web SSO ишке ашырууларынын бирин ишке ашыргандан кийин колдонмонун аныктыгын текшерүү кызматтары

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

  1. Windows PowerShell чакыруусун ачыңыз.
  2. Аткаруу саясатын өзгөртүү:
    Set-ExecutionPolicy Чексиз

Stage 1 Конфигурация параметрлерин чогултуу
Конфигурация параметрлеринин маанилерин аныктаңыз.

Параметр Description
WebService_Path Changepoint WCF жайгашкан жери Web Кызматтар web колдонмо files.
Демейки: \API\CP Web Кызматтар
Кызмат сертификаты_
аты		 Кабардын коопсуздук режимин колдонуп кардарларга кызматтын аныктыгын текшерүү үчүн колдонула турган сертификаттын аталышы.
Демейки: “CN=ChangepointAPICertificate” сертификаттын аталышы.
HTTPS талап кылынат HTTPS талап кылуу (Чын/Жалган)
Демейки: False.

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

  1.  PowerShell сунушун ачыңыз.
    Эскертүү: Эгер сервериңизде Колдонуучунун каттоо эсебин көзөмөлдөө иштетилген болсо, сиз администратордун жогорку уруксаттарын колдонуп PowerShell сунушун ачышыңыз керек.
  2. КПга өтүңүз web кызмат конфигурациясынын каталогу, демейки:
    ConfigurationCPWebКызмат
  3.  ./Configuration_AppAuth.ps1 аткарыңыз
  4. көрсөтмөлөрдү аткарыңыз.

WCF үчүн бир жолу кирүү (SSO) конфигурацияланууда Web Кызматтар
PowerShell конфигурациялоо

  1. Windows PowerShell чакыруусун ачыңыз.
  2. Аткаруу саясатын өзгөртүү:
    Set-ExecutionPolicy Чексиз

WCF үчүн ISAPI аркылуу SSO конфигурацияланууда Web Кызматтар
Stage 1 Конфигурация параметрлерин чогултуу
Төмөнкү конфигурация параметрлеринин маанилерин аныктаңыз.

Параметр Description
WebService_Path Changepoint WCF жайгашкан жер Web Кызматтар web колдонмо files.
Демейки: \API\CP Web Кызматтар
HTTPS талап кылынат HTTPS талап кылынат (Чын/Жалган).
Демейки: False.
Changepoint_RSA_
Cookie_Transform		 Cookie шифрлөө үчүн сиз колдонгон сертификаттын аталышы.
Демейки: “CN=ChangepointAPICertificate” сертификаттын аталышы.
Кызмат сертификатынын_аты Кабардын коопсуздук режимин колдонуп кардарларга кызматтын аныктыгын текшерүү үчүн колдонула турган сертификаттын атын киргизиңиз.
Демейки: “CN=ChangepointAPICertificate” сертификаттын аталышы.
SigningCertificate_Name Кол коюу сертификатынын атын киргизиңиз. Бул билдирүүлөргө кол коюу үчүн колдонгон сертификаттын аталышы.
Демейки: “CN=ChangepointAPICertificate” сертификаттын аталышы.
ISAPI_Mode ISAPI режими.
Демейки: NT
ISAPI_Header ISAPI_Mode "HEADER" болгондо колдонулат, мисалыampле, бош.
ClaimType SSO дооматынын түрүн киргизиңиз.
Демейки: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Конфигурация скрипттерин аткарыңыз

  1. PowerShell сунушун ачыңыз.
    Эскертүү: Эгер сервериңизде Колдонуучунун каттоо эсебин көзөмөлдөө иштетилген болсо, сиз администратордун жогорку уруксаттарын колдонуп PowerShell сунушун ачышыңыз керек.
  2. КПга өтүңүз web кызмат конфигурациясынын каталогу, демейки:
    ConfigurationCPWebКызмат
  3. Аткаруу: ./Configuration_SSO_ISAPI.ps1
  4. көрсөтмөлөрдү аткарыңыз.

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-беттеги “Ачык ачкычтарды кол менен жаңыртуу” караңыз.

Параметр Description
WebService_Path Changepoint 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” сертификаттын аталышы.
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конфигурация параметрлеринин маанилерин колдонгон сайттар.

  1. PowerShell сунушун ачыңыз.
    Эскертүү: Эгер сервериңизде Колдонуучунун каттоо эсебин көзөмөлдөө иштетилген болсо, сиз администратордун жогорку уруксаттарын колдонуп PowerShell сунушун ачышыңыз керек.
  2. Өзгөртүү пунктуна өтүңүз web кызмат конфигурациясынын каталогу, демейки: ConfigurationCPWebКызмат
  3.  Аткаруу: ./Configuration_SSO_ADFS.ps1
  4. көрсөтмөлөрдү аткарыңыз.

Stage 3 Партиялык ишенимди түзүү
ADFS 2.0 консолунда Relying Party Trust түзүңүз.

  1. ADFS сервериңизде ADFS 2.0 консолун ишке киргизиңиз.
  2. Аракет > Ишенген тараптын ишенимин кошуу тандаңыз.
  3. Start Click.
  4. Интернетте же жергиликтүү тармакта жарыяланган таянган тарап жөнүндө маалыматтарды импорттоо тандаңыз.
  5. Федерациянын метадайындарынын дарегин киргизип, андан кийин "Кийинки" баскычын басыңызampле:
    https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
  6. Көрсөтүлүүчү атын киргизиңиз, мисалы, Changepoint WCF API, жана Кийинки, Кийинки, Кийинки, анан Жабуу чыкылдатыңыз.
  7. Жогорудагы өзгөртүү чекитине таянган тарап үчүн доомат эрежесин кошуңуз. Changepoint үчүн демейки Доомат эрежесинин аталышы "UPN" болуп саналат.
  8. LDAP атрибутун “Колдонуучунун-Негизги-Аты-жөнүн” Чыгуучу дооматтын “* UPN” же “UPN” түрүнө салыштырыңыз.

Коомдук ачкычтарды кол менен жаңыртуу
ADFS Server Токен кол коюу бармагын алуу үчүн

  1. ADFS серверинен ADFS 2.0 башкаруу консолун ишке киргизиңиз.
  2. Кызмат > Сертификаттар тандаңыз жана Токенге кол коюу сертификатын эки жолу басыңыз.
  3. Маалымат тактасын тандаңыз.
  4. Бармак изи талаасын тандаңыз.
  5. Бармак изинин маанисин алуу үчүн бардык боштуктарды, анын ичинде биринчи боштукту алып салыңыз.

жаңыртуу үчүн Web.config file

  1. ADFSди түзөтүңүз web.config. Демейки жайгашкан жер:
    EnterpriseRP-STS_ADFS
  2. Астында элементи үчүн, ida:FederationMetadataLocation ачкычын таап, анын маанисин тазалаңыз:
  3. Under , табыңыз элемент жана аны төмөнкү менен алмаштырыңыз: https://ADFS_Federation.ServiceName/adfs/services/trust«>https://ADFS_Federation.ServiceName/adfs/services/trust” />

COM API байланышы сыналууда

  1. API Test Kit'ти иштетиңиз. Демейки жайгашкан жер:
    APIAPI ComponentsApiTestKit.exe.
  2. Connection String > Encrypter чыкылдатыңыз.
  3. Жөнөкөй Тексттик байланыштар сап талаасында:
    а. SERVERNAME жана DATABASENAME маалымат базасынын маалыматы менен алмаштырыңыз.
    б. USERID жана PASSWORD дегенди маалымат базасынын администраторунун колдонуучу каттоо эсебинин маалыматы менен алмаштырыңыз.
    в. Керектүү убакыттын маанисин киргизиңиз.
  4. Шифрлөө баскычын басыңыз.
  5. Шифрленген туташуу сабында текстти көчүрүңүз.
  6. Диалог кутусун жабыңыз.
  7. API Test Kit менюсунан Туташуу > COM API Connection Tester чыкылдатыңыз.
  8. Учурдагы версия өтмөгүндө, Шифрленген байланыш сабын Connection String талаасына чаптаңыз.
  9. LoginId жана Сырсөз талааларында Changepoint каттоо эсебиңиздин логин ID жана сырсөзүн киргизиңиз.
  10. Loglevel (0-8) талаасында COM API журналында кайтарыла турган ката маалыматынын деңгээлин көрсөтүңүз file тесттин натыйжасы байланышта көйгөйдү көрсөтсө.
    0 = Каттоо жок
    1 = Булак объекти жана ыкмасы
    2 = Ката кабары
    3 = Киргизүү параметрлери
    4 = Кайтаруу
    5 = Эскертүү
    8 = Текшерүү пункту
    Демейки 8.
  11. Connect Click.
    Эгер туташуу ийгиликтүү болсо, натыйжа талаасында ийгиликтүү кабар көрсөтүлөт. Эгер байланыш ишке ашпай калса, COM API журналын текшериңиз file каталар үчүн. Журналдын демейки жайгашкан жери file болуп саналат APIAPILlogs.

Орнотулган API компоненттеринин версиясы текшерилүүдө
Орнотулган компоненттер, анын ичинде чыгаруу версиясы жана жолун алуу үчүн версияны текшерүүчү утилитаны колдоно аласыз.

  1. CPVersionChecker.exe иштетиңиз. Демейки жол: APIAPI компоненттери
  2. Окууну басыңыз.

версиясын текшерүү Web Services API

  1. серверден Internet Explorerди ишке киргизиңиз Web Services API орнотулду жана даректи киргизиңиз:
    http://localhost.port/CPWeb.Service/WSLogin.asmx  бул жерде порт бул порттун номери webCP орнотулган сайтWebКызмат виртуалдык каталогу.
  2. WSLogin бетинде GetVersion шилтемесин басыңыз.
  3. Чакыруу чыкылдатыңыз.

тестирлөө Web Кызматтардын API туташуусу

  1. серверден Internet Explorerди ишке киргизиңиз Web Services API орнотулду жана даректи киргизиңиз: http://localhost.port/CPWeb.Service/WSLogin.asmx  бул жерде порт бул порттун номери webCP орнотулган сайтWebКызмат виртуалдык каталогу.
  2. WSLogin бетинде TestConnection шилтемесин чыкылдатыңыз.
  3. Чакыруу чыкылдатыңыз. 4. Сынактын жыйынтыгында:
  • Эгерде элемент жалган, сыноо байланышы ийгиликтүү болду.
  • Эгерде элемент чын, сыноо байланышы ишке ашкан жок. Көбүрөөк маалымат үчүн
    бузулуу себептери жөнүндө маалымат, карагыла жана тесттин натыйжаларындагы элементтерди жана API журналдарын текшериңиз. API журналдарынын демейки жолу: APIAPILlogs

орнотуу Web Тил сервериндеги Services API

  1. Changepoint орнотуу үчүн Web Тил сервериндеги Services API, сиз кошуу же жаңыртуу керек tag ичинде Web Services API web.config. демейки жайгашкан жери Web.config file бул: APICP Web КызматтарWeb.config
  2. Эгерде tag мурунтан эле бар болсо, маданият жана uiCulture атрибуттары тең "en-US" экенин текшериңиз.
  3. Эгерде tag мурунтан эле жок, төмөнкүлөрдү кошуңуз , комментарий жана элементтергеweb> түйүн:web>
    Visual Basic параметрлери: Берилиштер жоголуп кетиши мүмкүн болгон бардык маалымат түрүн өзгөртүүгө жол бербөө үчүн strict="true" коюңуз. Бардык өзгөрмөлөрдү жарыялоо үчүн ачык = "true" коюңуз. –>
  4. IIS кайра.

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

Changepoint API программасы [pdf] Орнотуу колдонмосу
API, Программалык камсыздоо, API Программасы

Шилтемелер

Окшош билдирүүлөр

Комментарий калтырыңыз

Сиздин электрондук почта дарегиңиз жарыяланбайт. Талап кылынган талаалар белгиленген *