API Instalazio Gida
Erreferentzia Gida
Aldaketa puntua 2021

© 2021 Changepoint Canada ULC Eskubide guztiak erreserbatuta. AEBko GOBERNUAREN ESKUBIDEAK- AEBetako Gobernuak erabiltzea, bikoiztu edo ezagutaraztea, Changepoint Canada ULC lizentzia-hitzarmenean ezarritako murrizketen mende dago eta DFARS 227.7202-1(a) eta 227.7202-3(a) (1995) ezarritakoaren arabera. DFARS 252.227-7013(c)(1)(ii) (1988ko URRIA), FAR 12.212(a) (1995), FAR 52.227-19 edo FAR 52.227-14 (ALT III), hala dagokionean. Produktu honek Changepoint Canada ULC-ren informazio konfidentziala eta sekretu komertzialak ditu. Dibulgazioa debekatuta dago Changepoint Canada ULC-ren aldez aurretik idatzizko baimenik gabe. Produktu hau erabiltzea Changepoint Canada ULC-rekin erabiltzailearen Lizentzia-Akordioaren baldintzen araberakoa da. Dokumentazioa Lizentziadunak barne erabilerarako soilik erreproduzi dezake. Dokumentu honen edukia ezin da aldatu, aldatu edo aldatu Changepoint Canada ULCren berariazko idatzizko baimenik gabe. Changepoint Canada ULC-k edozein unetan alda dezake hemen zehaztutako edukia, jakinarazpenarekin edo gabe.

Changepoint APIa instalatzen

Changepoint APIa instalatzeari buruz
Changepoint APIa COM API gisa erabilgarri dago, Windows Communication Foundation (WCF) zerbitzu gisa eta, atzerako bateragarritasunerako, gisa Web Zerbitzuen Hobekuntzak (WSE) zerbitzua. Changepoint APIari buruzko informazio gehiago lortzeko, ikusi Changepoint APIaren erreferentzia. Bertsio-oharrak, ohartarazpenak eta arazo ezagunetarako, ikusi Changepoint-eko talde-karpetetako bertsio-oharrak.
Changepoint APIa berritzea
Changepoint-en aurreko bertsio batetik berritzen ari bazara, erabili Windows Kontrol-panela Changepoint APIaren aurreko bertsioa eta haren osagaiak desinstalatzeko, bertsio hau instalatu aurretik.
Changepoint APIaren eskakizunak
Changepoint APIa instalatu aurretik Changepoint instalatu behar duzu. Software-eskakizunetarako, ikusi Changepoint Softwarearen Bateragarritasun Matrizea, 2021eko bertsio-oharrak eta adabakiak taldearen karpetan eskuragarri dagoena Changepoint-en.
File bide-konbentzioak
Dokumentu honetan zehar, konbentzio hauek erabiltzen dira bide arruntetarako:

• Changepoint instalazioaren erroko bidea.
  Bide lehenetsia hau da:
  C: Programa Files (x86)AldaketapuntuaAldaketa puntua
• Changepoint utilitate arrunten erro-kokapena, hala nola, Saioa hasteko ezarpenen utilitatea.
  Bide lehenetsia hau da:
  C: Programa Files (x86) Arrunta FilesAldaketapuntuaAldaketa puntua

Changepoint APIa instalatzen

1. Changepoint API mediaren erroko direktoriotik, exekutatu setup.exe.
2. Jarraitu argibideei Hautatu eginbideak pantaila agertu arte.
3. Hautatu instalatu nahi dituzun funtzioak, eta sakatu Hurrengoa.
4. Hautatu API helmuga karpeta, lehenetsia APIa eta egin klik Hurrengoa.
   Oharra: Changepoint saioa hasteko ezarpenen erabilgarritasuna instalatuta dago Saioaren ezarpenak, zehazten duzun helmuga karpeta edozein dela ere.
5. hautatu baduzu Web Zerbitzuen APIa: a. Hautatu denean
   a Web Gunearen pantaila agertzen da, hautatu a webdirektorio birtuala gehitzeko gunea, eta, ondoren, sakatu Hurrengoa.
   b. Sakatu Hurrengoa jarraitzeko. 6. APIaren instalazioa amaitutakoan, sakatu Amaitu.

Changepoint APIa konfiguratzea cachearen berri izateko
Changepoint APIa cachea jakitun izan dadin konfiguratzeko, ordezkatu "cache. Pasahitza" eta "cachea. Zerbitzariak” teklak CPn Web ZerbitzuakWeb.konfig file Enterprisen erabiltzen diren balioekinWeb.konfig file.
Gaitzen Web Zerbitzuen hobekuntzak (WSE)

1. Editatu Web.konfig file rentzat web zerbitzuak. Kokapen lehenetsia hau da:
   APICP Web ZerbitzuakWeb.konfig
2. Bilatu iruzkin-lerroaren hiru kasuak:
   < !– Kendu iruzkin hau erabiltzen ari bazara Web Zerbitzuen hobekuntzak (WSE) APIa. Utzi iruzkinak WCF zerbitzuak erabiltzen eta instalatzen ari ez bazara Web Zerbitzuaren hobekuntzak (WSE) –>
3. Kendu iruzkin-lerroaren instantzia bakoitzari jarraitzen dion elementuari:
   <section name=”microsoft.web.zerbitzuak2″ … >webZerbitzuak>web.zerbitzuak2>
   Oharra: ThewebZerbitzuak> iruzkin gabe utzi beharreko elementuaren seme-alaba daweb>.

Erregistroa konfiguratzen Web Zerbitzuen APIa
Erregistroa ezarri behar duzu file bide- eta erregistro-mailak. Log-mailak metatuak dira. Adibidezample, 3. maila zehazten baduzu, 1, 2 eta 3 mailak erregistratuko dira. Lehenetsitako erregistro-maila 8 da.

1. Editatu web zerbitzuak Web.konfig. Kokapen lehenetsia hau da:
   APICP Web ZerbitzuakWeb.konfig
2. Ezarri erregistroaFileBidea. Balio lehenetsia da APIAPILogs. 3. Ezarri LogLevel. Baliozko balioak hauek dira:
   0 = Ez dago erregistrorik
   1 = Iturburu-objektua eta metodoa
   2 = Errore mezua
   3 = Sarrera-parametroak
   4 = Itzuliak
   5 = Abisua
   8 = Kontrol-puntua

Direktorio birtualaren autentifikazioa konfiguratzen Web Zerbitzuen APIa
Sarbide anonimoa gaitu eta Windows integratua autentifikazioa desgaitu behar duzu CPrakoWebZerbitzuen direktorio birtuala Internet Informazio Zerbitzuetan (IIS). Informazio gehiago lortzeko, ikusi Microsoft IIS dokumentazioa.
Datu-baserako konexio-ezarpenak konfiguratzea Web Zerbitzuen APIa
Erabili Saioa hasteko ezarpenak erabilgarritasuna datu-basearen konexioaren ezarpenak enkriptatzeko Web Zerbitzuen APIa Web.konfig file. Informazio gehiago lortzeko, bilatu "Datu-basearen konexioaren ezarpenak konfiguratzea" Changepoint Instalazio Gidan.
Changepoint WCFrako autentifikazioa konfiguratzen Web Zerbitzuak
Aplikazioen autentifikazioa eta saio-hasiera bakarra (SSO) konfigura ditzakezu Changepoint WCFrako Web Zerbitzuak.
Inplementazio-aukera hauek eskuragarri daude Secure Token Service (STS) erabiliz:

• SSO ISAPI SSL erabiliz aukerakoa
• SSO WS-Federation (ADFS 2.0) erabiliz SSL behar da

SSL behar bada, konfigurazio scriptak erabiltzen dela ziurtatzen du.
ISAPI eta aplikazioen autentifikaziorako konfigurazio-scriptek aukeran gaitu dezakete SSL.
WCFrako aplikazioen autentifikazioa konfiguratzen Web Zerbitzuak
Changepoint WCF-ren autentifikazio-mota lehenetsia Web Zerbitzuak aplikazioen autentifikazioa da.
Erabili atal honetako prozedurak:

• konfiguratu Changepoint WCF Web Aplikazioen autentifikazioa SSLrekin erabiltzeko zerbitzuak
• leheneratu Changepoint WCF Web Aplikazioen autentifikaziorako zerbitzuak SSO inplementazioetako bat ezarri ondoren

Konfiguratu PowerShell

1. Ireki Windows PowerShell gonbita.
2. Aldatu exekuzio-politika:
   Ezarri exekuzio-politika mugagabea

Stage 1 Bildu konfigurazio-parametroak
Zehaztu konfigurazio-parametroen balioak.

Parametroa	Deskribapena
WebZerbitzua_bidea	Changepoint WCF-ren kokapena Web Zerbitzuak web aplikazioa files. Lehenetsia: \API\CP Web Zerbitzuak
Zerbitzu-ziurtagiria_ Izena	Mezuen segurtasun-modua erabiliz bezeroei zerbitzua autentifikatzeko erabiliko den ziurtagiri-izena. Lehenetsia: "CN=ChangepointAPICertificate" Ziurtagiriaren izena.
HTTPS eskatzen du	HTTPS eskatzen (Egia/Gezurra) Lehenetsia: faltsua.

Stage 2 Exekutatu konfigurazio-scriptak
Erabili konfigurazio-parametroen balioak konfigurazioa aldatzeko webguneak.

1.  Ireki PowerShell gonbita.
   Oharra: Zure zerbitzariak Erabiltzaile-Kontuen Kontrola gaituta badu, PowerShell-eko gonbita ireki behar duzu administratzaile-baimen handituak erabiliz.
2. Nabigatu CPra web zerbitzuaren konfigurazio direktorioa, lehenetsia:
   KonfigurazioaCPWebZerbitzua
3.  Exekutatu ./Configuration_AppAuth.ps1
4. Jarraitu gomendioak.

Saio-hasiera bakarra (SSO) konfiguratzen WCFrako Web Zerbitzuak
Konfiguratu PowerShell

1. Ireki Windows PowerShell gonbita.
2. Aldatu exekuzio-politika:
   Ezarri exekuzio-politika mugagabea

SSO konfiguratzen ISAPI erabiliz WCFrako Web Zerbitzuak
Stage 1 Bildu konfigurazio-parametroak
Zehaztu ondorengo konfigurazio-parametroen balioak.

Parametroa	Deskribapena
WebZerbitzua_bidea	Changepoint WCF-ren kokapena Web Zerbitzuak web aplikazioa files. Lehenetsia: \API\CP Web Zerbitzuak
HTTPS eskatzen du	HTTPS eskatzen du (Egia/Gezurra). Lehenetsia: faltsua.
Aldaketa_RSA_ Cookie_eraldaketa	Cookieak enkriptatzeko erabiltzen duzun ziurtagiriaren izena. Lehenetsia: "CN=ChangepointAPICertificate" Ziurtagiriaren izena.
ZerbitzuarenZurtagiriaren_izena	Idatzi mezuen segurtasun modua erabiliz bezeroei zerbitzua autentifikatzeko erabiliko den ziurtagiriaren izena. Lehenetsia: "CN=ChangepointAPICertificate" Ziurtagiriaren izena.
SinaduraZurtagiria_Izena	Idatzi sinadura-ziurtagiriaren izena. Hau da mezuak sinatzeko erabiltzen duzun ziurtagiriaren izena. Lehenetsia: "CN=ChangepointAPICertificate" Ziurtagiriaren izena.
ISAPI_Modea	ISAPI modua. Lehenetsia: NT
ISAPI_Goiburua	ISAPI_Mode "HEADER" denean erabiltzen den goiburua, adibidezample, hutsik.
ClaimType	Sartu SSO Erreklamazio Mota. Lehenetsia: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Exekutatu konfigurazio-scriptak

1. Ireki PowerShell gonbita.
   Oharra: Zure zerbitzariak Erabiltzaile-Kontuen Kontrola gaituta badu, PowerShell-eko gonbita ireki behar duzu administratzaile-baimen handituak erabiliz.
2. Nabigatu CPra web zerbitzuaren konfigurazio direktorioa, lehenetsia:
   KonfigurazioaCPWebZerbitzua
3. Exekutatu: ./Configuration_SSO_ISAPI.ps1
4. Jarraitu gomendioak.

SSO konfiguratzea WS-Federation (ADFS 2.0) erabiliz WCFrako Web Zerbitzuak
Stage 1 Bildu konfigurazio-parametroak
Zehaztu beheko taulan konfigurazio-parametroen balioak. Ziurtatu ADFS_Server_URI azken erabiltzailearen arakatzailearen Intranet eremuan dagoela.
Oharra: Lehenespenez, Changepoint segurtasun-tokenak sinatzeko erabiltzen diren gako publikoak automatikoki eguneratzeko konfiguratuta dago, argitaratutako federazioaren metadatuen dokumentua erabiliz. ADFSn hau da:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Zenbait kasutan, baliteke aldaketa puntutik ADFS zerbitzarira iristea ezinezkoa izatea web zerbitzaria, beraz, konfigurazio scripta exekutatu ondoren eskuz eguneratu beharko duzu konfigurazioa. Xehetasunetarako, ikusi "Gako publikoak eskuz eguneratzea" 12. orrialdean.

Parametroa	Deskribapena
WebZerbitzua_bidea	Changepoint WCF-ren kokapena Web Zerbitzuak web aplikazioa files. Lehenetsia: \API\CP Web Zerbitzuak
WebZerbitzua_URI	Changepoint WCF-rako erabiltzen duzun domeinu-identifikatzailea Web Zerbitzuak. Adibidezample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Cookieak enkriptatzeko erabiltzen duzun ziurtagiriaren izena. Lehenetsia: "CN=ChangepointApiCertificate" Ziurtagiriaren izena.
ZerbitzuarenZurtagiriaren_izena	Mezuen segurtasun-modua erabiliz bezeroei zerbitzua autentifikatzeko erabiliko den ziurtagiri-izena. Lehenetsia: "CN=ChangepointApiCertificate" Ziurtagiriaren izena.
SinaduraZurtagiria_Izena	Mezuak sinatzeko erabiltzen duzun ziurtagiriaren izena. Lehenetsia: "CN=ChangepointApiCertificate" Ziurtagiriaren izena erabiltzen da.
ADFS_ FederationServiceName	Federazioaren Zerbitzuaren izena. Izena lortzeko: ADFS zerbitzaritik, Abiarazi ADFS 2.0 Kudeaketa kontsola. •Hautatu ADFS 2.0 ezkerreko menuan. •Ekintza panelean, hautatu Editatu Federazio Zerbitzuaren Propietateak. Federazioaren Zerbitzuaren Izena Orokorra fitxan dago.
ClaimType	SSO erreklamazio mota. Lehenetsia hau da: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Exekutatu konfigurazio-scriptak
Konfiguratu webguneak konfigurazio-parametroen balioak erabiliz.

1. Ireki PowerShell gonbita.
   Oharra: Zure zerbitzariak Erabiltzaile-Kontuen Kontrola gaituta badu, PowerShell-eko gonbita ireki behar duzu administratzaile-baimen handituak erabiliz.
2. Nabigatu Aldaketa puntura web zerbitzuaren konfigurazio direktorioa, lehenetsia: KonfigurazioaCPWebZerbitzua
3.  Exekutatu: ./Configuration_SSO_ADFS.ps1
4. Jarraitu gomendioak.

Stage 3 Sortu konfiantzazko alderdien konfiantza
Sortu konfiantzazko alderdien konfiantza ADFS 2.0 kontsolan.

1. Zure ADFS zerbitzarian, abiarazi ADFS 2.0 kontsola.
2. Hautatu Ekintza > Gehitu konfiantzazko alderdiaren konfiantza.
3. Sakatu Hasi.
4. Hautatu Inportatu sarean edo sare lokal batean argitaratutako konfiantzazko alderdiari buruzko datuak.
5. Sartu Federazioaren metadatuen helbidea, eta sakatu Hurrengoa, adibidezample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Sartu Bistaratzeko izena, adibidez, Changepoint WCF APIa, eta egin klik Hurrengoa, Hurrengoa, Hurrengoa, eta gero Itxi.
7. Gehitu erreklamazio-arau bat goiko Aldaketa-puntu fidagarriaren alderdiarentzat. Aldaketa punturako, Erreklamazio-arauaren izena "UPN" da.
8. Mapeatu LDAP atributua "User-Principal-Name" irteerako erreklamazio mota "* UPN" edo "UPN".

Gako publikoak eskuz eguneratzea
ADFS Server Token Signing Thumbprinta lortzeko

1. ADFS zerbitzaritik, Abiarazi ADFS 2.0 Kudeaketa kontsola.
2. Hautatu Zerbitzua > Ziurtagiriak eta egin klik bikoitza Token sinadura-ziurtagirian.
3. Hautatu Xehetasunak fitxa.
4. Hautatu Erpurua eremua.
5. Erpuru-markaren balioa lortzeko, kendu zuriune guztiak lehenengo espazioa barne.

Eguneratzeko Web.konfig file

1. Editatu ADFS web.konfig. Kokapen lehenetsia hau da:
   EnterpriseRP-STS_ADFS
2. azpian elementua, bilatu ida:FederationMetadataLocation gakoa eta garbitu bere balioa:
   
3. Azpian , aurkitu elementua eta ordeztu honako honekin: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

COM API konexioa probatzen

1. Exekutatu API Test Kit. Kokapen lehenetsia hau da:
   APIAPI osagaiakApiTestKit.exe.
2. Sakatu Konexio-katea > Encrypter.
3. Testu arrunteko konexioen katea eremuan:
   a. Ordeztu SERVERNAME eta DATABASENAME zure datu-basearen informazioarekin.
   b. Ordeztu ERABILTZAILEA eta PASAHITZA zure datu-baseko administratzailearen erabiltzaile-kontuaren informazioarekin.
   c. Sartu denbora-muga-balioa behar den moduan.
4. Egin klik Enkriptatu aukeran.
5. Enkriptatutako konexio-katea eremuan, kopiatu testua.
6. Itxi elkarrizketa-koadroa.
7. API Test Kit menuan, sakatu Connection > COM API Connection Tester.
8. Uneko bertsioa fitxan, itsatsi enkriptatutako konexio-katea Konexio-katea eremuan.
9. LoginId eta Pasahitza eremuetan, sartu zure Changepoint konturako saioa hasteko IDa eta pasahitza.
10. Loglevel (0-8) eremuan, zehaztu COM API erregistroan itzuli beharreko errore-informazio maila. file probaren emaitzak konexioarekin arazoren bat erakusten badu.
    0 = Ez dago erregistrorik
    1 = Iturburu-objektua eta metodoa
    2 = Errore mezua
    3 = Sarrera-parametroak
    4 = Itzuliak
    5 = Abisua
    8 = Kontrol-puntua
    Lehenetsia 8 da.
11. Sakatu Konektatu.
    Konexioa arrakastatsua izan bada, arrakasta-mezu bat bistaratuko da Emaitza eremuan. Konexioak huts egin badu, egiaztatu COM APIaren erregistroa file akatsetarako. Erregistroaren kokapen lehenetsia file da APIAPILogs.

Instalatutako API osagaien bertsioa egiaztatzea
Bertsio-egiaztapenaren erabilgarritasuna erabil dezakezu instalatutako osagaiei buruzko xehetasunak lortzeko, bertsioaren bertsioa eta bidea barne.

1. Exekutatu CPVersionChecker.exe. Bide lehenetsia hau da: APIAPI osagaiak
2. Sakatu Irakurri.

Bertsioa egiaztatzen Web Zerbitzuen APIa

1. Abiarazi Internet Explorer zerbitzaritik Web Zerbitzuen APIa instalatuta dago eta idatzi helbidea:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  non portua portuaren zenbakia den webCP instalatu duzun guneaWebZerbitzuen direktorio birtuala.
2. WSLogin orrian, egin klik GetVersion estekan.
3. Sakatu Deitu.

Probatzen Web Zerbitzuen API konexioa

1. Abiarazi Internet Explorer zerbitzaritik Web Zerbitzuen APIa instalatuta dago eta idatzi helbidea: http://localhost.port/CPWeb.Service/WSLogin.asmx  non portua portuaren zenbakia den webCP instalatu duzun guneaWebZerbitzuen direktorio birtuala.
2. WSLogin orrian, egin klik TestConnection estekan.
3. Sakatu Deitu. 4. Proben emaitzetan:

• Bada elementua faltsua da, proba konexioa arrakastatsua izan da.
• Bada elementua egia da, probako konexioak huts egin du. Gehiagorako
  hutsegitearen arrazoiei buruzko informazioa, ikusi eta probaren emaitzetan elementuak eta egiaztatu APIaren erregistroak. API erregistroetarako bide lehenetsia hau da: APIAPILogs

Ezartzea Web Zerbitzuen APIa hizkuntza-zerbitzari batean

1. Aldaketa puntua zabaltzeko Web Zerbitzuen APIa hizkuntza zerbitzari batean, gehitu edo eguneratu behar duzu tag urtean Web Zerbitzuen APIa web.konfig. kokapen lehenetsia Web.konfig file hau da: APICP Web ZerbitzuakWeb.konfig
2. bada tag dagoeneko badago, ziurtatu kultura eta uiCulture atributuak "en-US" direla.
3. bada tag dagoeneko existitzen ez dena, gehitu honako hau , komentatu eta elementuakweb> nodoa:web>
   Visual Basic aukerak: ezarri strict="true" datu-moten bihurketa guztiak ez onartzeko, non datuak gal daitezkeen. Ezarri explicit="true" aldagai guztien deklarazioa behartzeko. –>
4. Berrabiarazi IIS.

Dokumentuak / Baliabideak

Changepoint API softwarea [pdfInstalazio Gida API, Software, API Software

Erreferentziak

• Erabiltzailearen eskuliburua