API Installation Guide
Reference Guide
Changepoint 2021

© 2021 Changepoint Canada ULC Kodzero dzese dzakachengetwa. KODZERO ZEHURUMENDE YEUS-Kushandisa, kudzokorora, kana kuburitswa neHurumende yeUS zviri pasi pezvirambidzo sezvakarongwa muchibvumirano cherezinesi cheChangepoint Canada ULC uye sekupihwa kweDFARS 227.7202-1(a) uye 227.7202-3(a) (1995), DFARS 252.227-7013(c) (1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, kana FAR 52.227-14 (ALT III), sezviri kushanda. Ichi chigadzirwa chine ruzivo rwakavanzika uye zvakavanzika zvekutengesa zveChangepoint Canada ULC. Kuzivisa kunorambidzwa pasina mvumo yakanyorwa yakanyorwa yeChangepoint Canada ULC. Kushandiswa kwechigadzirwa ichi kunoenderana nematemu uye mamiriro emushandisi Rezinesi Chibvumirano neChangepoint Canada ULC. Zvinyorwa zvinogona kungogadzirwazve neMurezinesi kuti zvishandiswe mukati. Zviri mugwaro iri hazvigone kushandurwa, kugadziridzwa kana kuchinjwa pasina mvumo yakanyorwa yeChangepoint Canada ULC. Changepoint Canada ULC inogona kushandura zvirimo zvakatsanangurwa pano chero nguva, paine kana pasina chiziviso.

Zviri mukati hide
1 Kuisa iyo Changepoint API
2 Kuedza kubatana kweCOM API
3 Testing the Web Services API yekubatanidza
4 Zvinyorwa / Zvishandiso
4.1 References
5 Related Posts

Kuisa iyo Changepoint API

Nezve kuisa iyo Changepoint API
Iyo Changepoint API inowanikwa seCOM API, Windows Communication Foundation (WCF) sevhisi uye, yekudzokera kumashure kuenderana, se Web Services Enhancements (WSE) sevhisi. Kuti uwane ruzivo nezve Changepoint API, ona iyo Changepoint API Reference. Kuti uwane zvinyorwa zvekusimudzira, macaveats uye nyaya dzinozivikanwa, ona Release Notes mumafolda echikwata muChangepoint.
Kuvandudza Changepoint API
Kana iwe uri kusimudzira kubva kune yapfuura kuburitswa kweChangepoint, shandisa iyo Windows Control Panel kuburitsa iyo yapfuura vhezheni yeChangepoint API nezvikamu zvayo usati waisa iyi vhezheni.
Changepoint API zvinodiwa
Iwe unofanirwa kuisa Changepoint usati waisa iyo Changepoint API. Kune zvinodiwa nesoftware, ona Changepoint Software Compatibility Matrix, iyo inowanikwa mu2021 Release Notes uye Patches timu folda muChangepoint.
File nzira kokorodzano
Mugwaro rese iri, zvinotevera zvibvumirano zvinoshandiswa kune zvakajairika nzira:

  • Iyo midzi nzira yekuisa Changepoint.
    Iyo yakasarudzika nzira ndeye:
    C: Chirongwa Files (x86)ChangepointChangepoint
  • Iyo mudzi nzvimbo yezvakajairwa Changepoint zvishandiso, senge Login Settings utility.
    Iyo yakasarudzika nzira ndeye:
    C: Chirongwa Files (x86) Zvakajairika FilesChangepointChangepoint

Kuisa iyo Changepoint API

  1. Kubva pane Changepoint API midhiya midzi dhairekitori, mhanya setup.exe.
  2. Tevedza zvinokurudzirwa kusvika Sarudza Zvimiro skrini yabuda.
  3. Sarudza maficha aunoda kuisa, wobva wadzvanya Next.
  4. Sarudza iyo API yekuenda folda, default API, uye tinya Next.
    Cherechedza: Iyo Changepoint Login Settings utility yakaiswa mukati LoginSettings, zvisinei nefolda yekwaunotsanangura.
  5. Kana ukasarudza iyo Web Purogiramu inonzi Services: a. Kana Sarudza
    a Web Saiti skrini inooneka, sarudza a websaiti yekuwedzera iyo chaiyo dhairekitori, wobva wadzvanya Next.
    b. Dzvanya Next kuti uenderere mberi. 6. Kana kuiswa kweAPI kwapera, tinya Finish.

Kugadzirisa iyo Changepoint API kuve cache kuziva
Kuti ugadzirise iyo Changepoint API kuti ive cache-inoziva, tsiva kukosha kweiyo "cache. Password" uye "cache. Sevha" makiyi muCP Web ServicesWeb.config file nehunhu hunoshandiswa muBhizinesiWeb.config file.
Kugonesa Web Masevhisi Enhancements (WSE)

  1. Edit the Web.config file nokuti web masevhisi. Nzvimbo yakasarudzika ndeiyi:
    APICP Web ServicesWeb.config
  2. Tsvaga zviitiko zvitatu zvemutsara wekutaura unotevera:
    < !– Bvisa chinhu chinotevera kana uri kushandisa Web Purogiramu inonzi Service Enhancements (WSE) Siya mhinduro kana uchishandisa WCF masevhisi uye usiri kuisa Web Kuwedzera Kwebasa (WSE) ->
  3. Bvisa chinhu chinotevera chiitiko chimwe nechimwe chemutsara wekutaura:
    <section name=”microsoft.web.services2″ … >webServices>web.mabasa2>
    Cherechedza: ThewebMasevhisi> chinhu chinofanirwa kuve chisina kutaurwa mwana weweb>.

Kugadzirisa matanda eiyo Web Purogiramu inonzi Services
Iwe unofanirwa kuseta irogi file nzira uye log mazinga. Marogi mazinga ari kuwanda. For example, kana ukatsanangura nhanho 3, ipapo mazinga 1, 2, uye 3 akanyorwa. Iyo default log level ndeye 8.

  1. Edit the web masevhisi Web.config. Nzvimbo yakasarudzika ndeiyi:
    APICP Web ServicesWeb.config
  2. Seta iyo LogFilePath. Iko kukosha kwekutanga ndiko APILogs. 3. Isa iyo LogLevel. Izvo zvakakosha ndezvi:
    0 = Hapana kutema miti
    1 = Kunobva chinhu uye nzira
    2 = Mhosho meseji
    3 = Input parameters
    4 = Returns
    5 = Yambiro
    8 = Checkpoint

Kugadzirisa dhairekitori rechokwadi reiyo Web Purogiramu inonzi Services
Iwe unofanirwa kugonesa kusazivikanwa kuwana uye kudzima Yakabatanidzwa Windows kuvimbiswa kweCPWebService virtual directory muInternet Information Services (IIS). Kuti uwane rumwe ruzivo, ona zvinyorwa zveMicrosoft IIS.
Kugadzirisa zvigadziriso zvekubatanidza database ye Web Purogiramu inonzi Services
Shandisa iyo Login Settings utility kuti encrypt iyo database yekubatanidza marongero mu Web Purogiramu inonzi Services Web.config file. Kuti uwane rumwe ruzivo, tsvaga "Kugadzirisa Database Yekubatanidza Settings" muChangepoint Installation Guide.
Kugadzirisa kuvimbiswa kweChangepoint WCF Web Services
Iwe unogona kugadzirisa Chikumbiro Chekusimbisa uye kusaina kamwechete (SSO) yeChangepoint WCF Web Services.
Aya anotevera ekuita sarudzo anowanikwa uchishandisa Secure Token Service (STS):

  • SSO uchishandisa ISAPI SSL sarudzo
  • SSO uchishandisa WS-Federation (ADFS 2.0) SSL inodiwa

Kana SSL ichidikanwa, iyo script yekumisikidza inovimbisa kuti inoshandiswa.
Zvinyorwa zvekumisikidza zveISAPI uye chokwadi chekushandisa zvinogona kugonesa SSL.
Kugadzirisa kuvimbiswa kwekushandisa kweWCF Web Services
Iyo yekusarudzika yekusimbisa mhando yeChangepoint WCF Web Masevhisi ndeyechokwadi chekushandisa.
Shandisa maitiro ari muchikamu chino ku:

  • gadzirisa Changepoint WCF Web Masevhisi ekushandisa echokwadi yekushandisa neSSL
  • dzosera Changepoint WCF Web Masevhisi ekutendesa kwekushandisa mushure mekuita imwe yekushandiswa kweSSO

Gadzirisa PowerShell

  1. Vhura Windows PowerShell nekukurumidza.
  2. Shandura mutemo wekuita:
    Set-ExecutionPolicy isina Kurambidzwa

Stage 1 Unganidza zvigadziriso zvimiro
Sarudza kukosha kwezvigadziro zvekugadzirisa.

Parameter Tsanangudzo
WebService_Path Nzvimbo ye Changepoint WCF Web Services web application files.
Default: \API\CP Web Services
ServiceCertificate_
Zita		 Zita reSitifiketi rinozoshandiswa kutsigira sevhisi kune vatengi vachishandisa Meseji kuchengetedza modhi.
Default: iyo "CN=ChangepointAPICertificate" Zita reSitifiketi.
inoda HTTPS Inoda HTTPS (Chokwadi/Nhema)
Default: Nhema.

Stage 2 Ita zvinyorwa zvekugadzirisa
Shandisa kukosha kweiyo configuration parameters kugadzirisa kugadzirisa kwe webnzvimbo.

  1.  Vhura PowerShell nekukurumidza.
    Cherechedza: Kana sevha yako ine User Account Control yakagoneswa, iwe unofanirwa kuvhura iyo PowerShell nekukurumidza uchishandisa yakakwirira mvumo yemutungamiriri.
  2. Enda kuCP web service configuration directory, default:
    ConfigurationCPWebService
  3.  Enda ./Configuration_AppAuth.ps1
  4. Tevedzera zvaunoudzwa.

Kugadzirisa kusaina-kumwe (SSO) yeWCF Web Services
Gadzirisa PowerShell

  1. Vhura Windows PowerShell nekukurumidza.
  2. Shandura mutemo wekuita:
    Set-ExecutionPolicy isina Kurambidzwa

Kugadzirisa SSO uchishandisa ISAPI yeWCF Web Services
Stage 1 Unganidza zvigadziriso zvimiro
Sarudza kukosha kwezvinotevera zvigadziriso parameters.

Parameter Tsanangudzo
WebService_Path Nzvimbo yeChangepoint WCF Web Services web application files.
Default: \API\CP Web Services
inoda HTTPS Inoda HTTPS (Chokwadi/Nhema).
Default: Nhema.
Changepoint_RSA_
Cookie_Shandura		 Zita rechitupa chaunoshandisa kuCookie encryption.
Default: iyo "CN=ChangepointAPICertificate" Zita reSitifiketi.
ServiceCertificate_Name Pinda zita retifiketi richashandiswa kuratidza sevhisi kune vatengi uchishandisa Meseji kuchengetedza modhi.
Default: iyo "CN=ChangepointAPICertificate" Zita reSitifiketi.
SigningCertificate_Name Isa zita rechitupa chekusaina. Iri ndiro zita rechitupa chaunoshandisa kusaina mameseji.
Default: iyo "CN=ChangepointAPICertificate" Zita reSitifiketi.
ISAPI_Mode Iyo ISAPI mode.
Default: NT
ISAPI_Header Musoro unoshandiswa kana ISAPI_Mode iri "HEADER", semuenzanisoample, blank.
ClaimType Isa iyo SSO Claim Type.
Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ita zvinyorwa zvekugadzirisa

  1. Vhura PowerShell nekukurumidza.
    Cherechedza: Kana sevha yako ine User Account Control yakagoneswa, iwe unofanirwa kuvhura iyo PowerShell nekukurumidza uchishandisa yakakwirira mvumo yemutungamiriri.
  2. Enda kuCP web service configuration directory, default:
    ConfigurationCPWebService
  3. Ita: ./Configuration_SSO_ISAPI.ps1
  4. Tevedzera zvaunoudzwa.

Kugadzirisa SSO uchishandisa WS-Federation (ADFS 2.0) yeWCF Web Services
Stage 1 Unganidza zvigadziriso zvimiro
Sarudza kukosha kwezvigadziro zvekugadzirisa mutafura, pazasi. Ita shuwa kuti ADFS_Server_URI iri muIntranet zone yebrowser yemushandisi wekupedzisira.
Cherechedza: Nekumisikidza, Changepoint inorongedzerwa kuti igadzirise otomatiki makiyi eruzhinji anoshandiswa kusaina chengetedzo tokeni nekushandisa rakaburitswa mubatanidzwa metadata gwaro. MuADFS izvi ndezvi:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Mune zvimwe zviitiko zvingave zvisingaite kusvika kune ADFS server kubva kuChangepoint web server saka iwe uchafanirwa kugadzirisa nemaoko kugadzirisa mushure mekuita script yekumisikidza. Kuti uwane rumwe ruzivo, ona "Kuvandudza makiyi eruzhinji nemaoko" papeji 12.

Parameter Tsanangudzo
WebService_Path Nzvimbo ye Changepoint WCF Web Services web application files. Default: \API\CP Web Services
WebSevhisi_URI Domain identifier yaunoshandisa yeChangepoint WCF Web Services. For example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform Zita rechitupa chaunoshandisa Cookie encryption. Default: iyo "CN=ChangepointApiCertificate" Zita reSitifiketi.
ServiceCertificate_Name Zita reSitifiketi rinozoshandiswa kutsigira sevhisi kune vatengi vachishandisa Meseji kuchengetedza modhi.
Default: iyo "CN=ChangepointApiCertificate" Zita reSitifiketi.
SigningCertificate_Name Zita rechitupa chaunoshandisa kusaina mameseji.
Default: iyo "CN=ChangepointApiCertificate" Zita reSitifiketi rinoshandiswa.
ADFS_ FederationServiceName Federation Service Zita. Kuti uwane zita: Kubva kuAdFS server, Tangisa ADFS 2.0 Management console.
•Sarudza ADFS 2.0 kubva kuruboshwe menyu.
•Kubva pane Action pane sarudza Edit Federation Service Properties.
Zita reFederation Service riri paGeneral tab.
ClaimType SSO Claim Type. Iyo default ndeye: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ita zvinyorwa zvekugadzirisa
Configure the webmasosi anoshandisa kukosha kweiyo configuration parameters.

  1. Vhura PowerShell nekukurumidza.
    Cherechedza: Kana sevha yako ine User Account Control yakagoneswa, iwe unofanirwa kuvhura iyo PowerShell nekukurumidza uchishandisa yakakwirira mvumo yemutungamiriri.
  2. Enda kune Changepoint web service configuration directory, default: ConfigurationCPWebService
  3.  Ita: ./Configuration_SSO_ADFS.ps1
  4. Tevedzera zvaunoudzwa.

Stage 3 Gadzira kuvimba kwebato rinovimbika
Gadzira iyo Relying Party Trust muADFS 2.0 Console.

  1. Pane yako ADFS server, tanga iyo ADFS 2.0 koni.
  2. Sarudza Chiito> Wedzera Relying Party Trust.
  3. Click Start.
  4. Sarudza Kupinza data nezve bato rinovimbika rakaburitswa online kana kunetiweki yemuno.
  5. Pinda iyo Federation metadata kero, wobva wadzvanya Next, kune example:
    https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
  6. Isa zita reKuratidza, semuenzaniso Changepoint WCF API, wodzvanya Next, Next, Next, wozovhara.
  7. Wedzera Chirevo Rule chepamusoro Changepoint Relying Bato. Kune Changepoint, iyo yakasarudzika Claim mutemo zita ndeye "UPN".
  8. Mepu iyo LDAP Attribute "Mushandisi-Mukuru-Zita" kune Inobuda Claim Type "* UPN" kana "UPN".

Kugadziridza makiyi eruzhinji nemaoko
Kuti uwane iyo ADFS Server Token Signing Thumbprint

  1. Kubva kuAdFS server, Tangisa ADFS 2.0 Management console.
  2. Sarudza Sevhisi> Zvitupa, uye tinya kaviri Chiratidzo-kusaina chitupa.
  3. Sarudza iyo Details tab.
  4. Sarudza iyo Thumbprint ndima.
  5. Kuti uwane kukosha kwechigunwe, bvisa nzvimbo dzese kusanganisira yekutanga nzvimbo.

To update the Web.config file

  1. Rongedza iyo ADFS web.config. Nzvimbo yakasarudzika ndeiyi:
    EnterpriseRP-STS_ADFS
  2. Pasi pe chinhu, tsvaga iyo ida:FederationMetadataLocation kiyi uye jekesa kukosha kwayo:
  3. Under ,wana element uye woitsiva neinotevera: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

Kuedza kubatana kweCOM API

  1. Mhanya iyo API Test Kit. Nzvimbo yakasarudzika ndeiyi:
    API ComponentsApiTestKit.exe.
  2. Dzvanya Connection String> Encrypter.
  3. Mundima yePlain Text Connections tambo:
    a. Tsiva SERVERNAME neDATABASENAME neruzivo rwako rwedatabase.
    b. Tsiva USERID uye PASSWORD nedatabase yako admin mushandisi account ruzivo.
    c. Isa kukosha kwekupedza nguva sezvinodiwa.
  4. Dzvanya Encrypt.
  5. MuNzvimbo Yakavharidzirwa Yekubatanidza tambo, kopira zvinyorwa.
  6. Vhara dialog box.
  7. Pa API Test Kit menyu, tinya Connection > COM API Connection Tester.
  8. MuTebhu Yezvino Shanduro, namira tambo yekubatanidza yakavharidzirwa muConnection String field.
  9. MuLoginId uye Password minda, isa iyo yekupinda ID uye password kune yako Changepoint account.
  10. Mundima yeLoglevel (0-8), tsanangura mwero weruzivo rwemhosho ruchadzoserwa muCOM API log. file kana mhinduro yebvunzo inoratidza dambudziko nekubatanidza.
    0 = Hapana kutema miti
    1 = Kunobva chinhu uye nzira
    2 = Mhosho meseji
    3 = Input parameters
    4 = Returns
    5 = Yambiro
    8 = Checkpoint
    Iyo default ndeye 8.
  11. Dzvanya Connect.
    Kana kubatana kwakabudirira, meseji yekubudirira inoratidzwa muResult field. Kana kubatana kwakundikana, tarisa iyo COM API log file nokuda kwezvikanganiso. Nzvimbo yakasarudzika yerogi file ndizvo APILogs.

Kutarisa vhezheni yeakaiswa API zvikamu
Unogona kushandisa vhezheni yekutarisa utility kuti uwane ruzivo nezve zvakaiswa zvikamu, kusanganisira yekuburitsa vhezheni uye nzira.

  1. Mhanya CPVersionChecker.exe. Iyo yakasarudzika nzira ndeye: API API Zvikamu
  2. Baya Read.

Kuongorora shanduro ye Web Purogiramu inonzi Services

  1. Vhura Internet Explorer kubva kune server uko iyo Web Services API yakaiswa, uye isa kero:
    http://localhost.port/CPWeb.Service/WSLogin.asmx  uko port ndiyo nhamba yechiteshi che webnzvimbo yawakaisa iyo CPWebService virtual directory.
  2. PaWSLogin peji, tinya GetVersion link.
  3. Click Invoke.

Testing the Web Services API yekubatanidza

  1. Vhura Internet Explorer kubva kune server uko iyo Web Services API yakaiswa, uye isa kero: http://localhost.port/CPWeb.Service/WSLogin.asmx  uko port ndiyo nhamba yechiteshi che webnzvimbo yawakaisa iyo CPWebService virtual directory.
  2. Pa WSLogin peji tinya TestConnection link.
  3. Click Invoke. 4. Mune mhinduro dzebvunzo:
  • Kana chinhu manyepo, bvunzo yekubatanidza yabudirira.
  • Kana element ichokwadi, bvunzo yekubatanidza yakundikana. For more
    ruzivo pamusoro pezvikonzero zvekukundikana, ona uye zvinhu mumhedzisiro yebvunzo, uye tarisa iyo API logs. Iyo yakasarudzika nzira kune API logs ndeiyi: APILogs

Kugadzira iyo Web Purogiramu yeSevhisi pasevha yemutauro

  1. Kuendesa iyo Changepoint Web Masevhisi API pane server yemutauro, iwe unofanirwa kuwedzera kana kugadzirisa iyo tag mu Web Purogiramu inonzi Services web.config. Nzvimbo yakasarudzika ye Web.config file ndizvo: APICP Web ServicesWeb.config
  2. Kana iyo tag yatovepo, ita shuwa kuti zvese tsika uye uiCulture hunhu "en-US."
  3. Kana iyo tag haisati iripo, wedzera zvinotevera , comment, uye zvinhu kuneweb> node:web>
    Visual Basic sarudzo: Seta yakasimba = "chokwadi" kusatendera ese data mhando shanduko uko kurasikirwa kwedata kunogona kuitika. Seta zvakajeka = "chokwadi" kumanikidza kuziviswa kwezvose zvakasiyana. ->
  4. Kutangazve IIS.

Zvinyorwa / Zvishandiso

Changepoint API Software [pdf] Installation Guide
API, Software, API Software

References

Related Posts

Siya mhinduro

Yako email kero haizoburitswa. Nzvimbo dzinodiwa dzakamakwa *