API installijuhend
Teatmeteos
Muudatuspunkt 2021

© 2021 Changepoint Canada ULC Kõik õigused kaitstud. USA VALITSUSE ÕIGUSED – USA valitsuse poolt kasutamise, paljundamise või avalikustamise suhtes kehtivad piirangud, mis on sätestatud Changepoint Canada ULC litsentsilepingus ning DFARS 227.7202-1(a) ja 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19 või FAR 52.227-14 (ALT III), vastavalt vajadusele. See toode sisaldab Changepoint Canada ULC konfidentsiaalset teavet ja ärisaladusi. Avalikustamine on keelatud ilma Changepoint Canada ULC eelneva kirjaliku loata. Selle toote kasutamisel kehtivad kasutaja ja Changepoint Canada ULC litsentsilepingu tingimused. Dokumentatsiooni võib reprodutseerida ainult litsentsiaat sisekasutuseks. Selle dokumendi sisu ei tohi muuta, muuta ega muuta ilma Changepoint Canada ULC selgesõnalise kirjaliku nõusolekuta. Changepoint Canada ULC võib siin nimetatud sisu igal ajal etteteatamata või ette teatamata muuta.

Changepoint API installimine

Teave Changepoint API installimise kohta
Changepoint API on saadaval COM API, Windows Communication Foundationi (WCF) teenusena ja tagasiühilduvuse jaoks Web Services Enhancements (WSE) teenus. Lisateavet Changepoint API kohta leiate jaotisest Changepoint API viide. Täiendusmärkuste, hoiatuste ja teadaolevate probleemide kohta vaadake Changepointi meeskonnakaustade väljalaskemärkmeid.
Changepoint API uuendamine
Kui uuendate Changepointi eelmiselt versioonilt, kasutage enne selle versiooni installimist Changepoint API eelmise versiooni ja selle komponentide desinstallimiseks Windowsi juhtpaneeli.
Changepoint API nõuded
Enne Changepoint API installimist peate installima Changepointi. Tarkvaranõuete kohta vaadake Changepointi tarkvara ühilduvusmaatriksit, mis on saadaval Changepointi 2021. aasta väljalaskemärkmete ja paikade meeskonnakaustas.
File teekonventsioonid
Selles dokumendis kasutatakse ühiste teede jaoks järgmisi konventsioone.

• Changepointi installi juurtee.
  Vaikimisi tee on:
  C: Programm Files (x86)ChangepointChangepoint
• Tavaliste Changepointi utiliitide (nt sisselogimisseadete utiliit) juurasukoht.
  Vaikimisi tee on:
  C: Programm Files (x86) Tavaline FilesChangepointChangepoint

Changepoint API installimine

1. Käivitage Changepoint API meedia juurkataloogis setup.exe.
2. Järgige juhiseid, kuni kuvatakse funktsioonide valimise ekraan.
3. Valige funktsioonid, mida soovite installida, ja seejärel klõpsake nuppu Edasi.
4. Valige vaikimisi API sihtkaust API ja klõpsake nuppu Edasi.
   Märkus. Muudatuspunkti sisselogimisseadete utiliit on installitud LoginSettings, olenemata teie määratud sihtkaustast.
5. Kui valisite Web Services API: a. Kui Vali
   a Web Ilmub saidi ekraan, valige a websait, kuhu virtuaalne kataloog lisada, ja seejärel klõpsake nuppu Edasi.
   b. Jätkamiseks klõpsake nuppu Edasi. 6. Kui API installimine on lõpetatud, klõpsake nuppu Lõpeta.

Changepoint API konfigureerimine nii, et see oleks vahemälust teadlik
Changepoint API vahemäluteadlikuks konfigureerimiseks asendage vahemälu vahemälu väärtused. Parool” ja „vahemälu. Serverid” võtmed CP-s Web TeenusedWeb.config file Ettevõtluses kasutatavate väärtustegaWeb.config file.
Lubamine Web Teenuste täiustused (WSE)

1. Redigeeri Web.config file jaoks web teenuseid. Vaikimisi asukoht on:
   APICP Web TeenusedWeb.config
2. Otsige üles järgmise kommentaarirea kolm juhtumit:
   < !– Kui kasutate, eemaldage järgmise elemendi kommentaar Web Service Enhancements (WSE) API. Kui kasutate WCF-teenuseid ja te ei installi, jätke kommentaarid Web Service Enhancements (WSE) –>
3. Tühjendage igale kommentaarirea eksemplarile järgneva elemendi kommentaar:
   <section name=”microsoft.web.services2″ … >webTeenused>web.teenused2>
   Märkus. ThewebKommenteerimata element Services> on alamelementweb>.

Logimise konfigureerimine Web Services API
Peate logi määrama file tee ja logi tasemed. Logitasemed on kumulatiivsed. Näiteksample, kui määrate taseme 3, siis tasemed 1, 2 ja 3 logitakse. Vaikimisi logitase on 8.

1. Redigeeri web teenuseid Web.config. Vaikimisi asukoht on:
   APICP Web TeenusedWeb.config
2. Määra logiFileTee. Vaikeväärtus on APIAPILogid. 3. Seadke LogLevel. Kehtivad väärtused on:
   0 = logimine puudub
   1 = Lähteobjekt ja meetod
   2 = Veateade
   3 = Sisendparameetrid
   4 = Tagastab
   5 = Hoiatus
   8 = kontrollpunkt

Virtuaalse kataloogi autentimise konfigureerimine Web Services API
Peate lubama anonüümse juurdepääsu ja keelama CP jaoks integreeritud Windowsi autentimiseWebTeenuse virtuaalne kataloog Interneti-teabeteenustes (IIS). Lisateabe saamiseks vaadake Microsoft IIS-i dokumentatsiooni.
Andmebaasi ühenduse seadete konfigureerimine Web Services API
Kasutage utiliiti Login Settings, et krüptida andmebaasi ühenduse sätted Web Services API Web.config file. Lisateabe saamiseks otsige Changepointi installijuhendist "Andmebaasiühenduse sätete konfigureerimine".
Changepoint WCF-i autentimise konfigureerimine Web Teenused
Saate konfigureerida rakenduse autentimise ja ühekordse sisselogimise (SSO) Changepoint WCF-i jaoks Web Teenused.
Secure Token Service (STS) abil on saadaval järgmised juurutusvalikud.

• ISAPI SSL-i kasutav SSO valikuline
• WS-Federationi (ADFS 2.0) kasutav SSO nõutav SSL

Kui SSL on nõutav, tagab konfiguratsiooniskript selle kasutamise.
ISAPI ja rakenduse autentimise konfiguratsiooniskriptid võivad valikuliselt lubada SSL-i.
Rakenduse autentimise konfigureerimine WCF-i jaoks Web Teenused
Changepoint WCF-i vaike autentimise tüüp Web Teenused on rakenduse autentimine.
Kasutage selles jaotises toodud protseduure, et:

• konfigureerige Changepoint WCF Web Teenused rakenduse autentimise kasutamiseks SSL-iga
• ennista Changepoint WCF Web Rakenduse autentimise teenused pärast ühe SSO-rakenduse rakendamist

PowerShelli konfigureerimine

1. Avage Windows PowerShelli viip.
2. Muutke täitmispoliitikat:
   Set-ExecutionPolicy piiranguteta

Stage 1 Koguge konfiguratsiooniparameetrid
Määrake konfiguratsiooniparameetrite väärtused.

Parameeter	Kirjeldus
WebService_Path	Changepoint WCF-i asukoht Web Teenused web rakendus files. Vaikimisi: \API\CP Web Teenused
Service Certificate_ Nimi	Sertifikaadi nimi, mida kasutatakse teenuse autentimiseks sõnumiturberežiimi kasutavatele klientidele. Vaikimisi: "CN=ChangepointAPICertificate" sertifikaadi nimi.
nõuavad HTTPS-i	Nõua HTTPS-i (tõene/vale) Vaikimisi: Väär.

Stage 2 Käivitage konfiguratsiooniskriptid
Konfiguratsiooni konfiguratsiooni muutmiseks kasutage konfiguratsiooniparameetrite väärtusi websaidid.

1.  Avage PowerShelli viip.
   Märkus. Kui teie serveris on kasutajakonto kontroll lubatud, peate avama PowerShelli viiba kõrgendatud administraatoriõigustega.
2. Navigeerige CP-sse web teenuse konfiguratsioonikataloog, vaikimisi:
   ConfigurationCPWebTeenindus
3.  Käivitage fail ./Configuration_AppAuth.ps1
4. Järgige juhiseid.

WCF-i jaoks ühekordse sisselogimise (SSO) konfigureerimine Web Teenused
PowerShelli konfigureerimine

1. Avage Windows PowerShelli viip.
2. Muutke täitmispoliitikat:
   Set-ExecutionPolicy piiranguteta

SSO konfigureerimine ISAPI abil WCF-i jaoks Web Teenused
Stage 1 Koguge konfiguratsiooniparameetrid
Määrake järgmiste konfiguratsiooniparameetrite väärtused.

Parameeter	Kirjeldus
WebService_Path	Changepoint WCF-i asukoht Web Teenused web rakendus files. Vaikimisi: \API\CP Web Teenused
nõuavad HTTPS-i	Nõua HTTPS-i (True/False). Vaikimisi: Väär.
Changepoint_RSA_ Cookie_Transform	Selle sertifikaadi nimi, mida kasutate küpsiste krüptimiseks. Vaikimisi: "CN=ChangepointAPICertificate" sertifikaadi nimi.
ServiceCertificate_Name	Sisestage sertifikaadi nimi, mida kasutatakse sõnumi turvarežiimis klientidele teenuse autentimiseks. Vaikimisi: "CN=ChangepointAPICertificate" sertifikaadi nimi.
Allkirjastamise sertifikaadi_nimi	Sisestage allkirjastamissertifikaadi nimi. See on sertifikaadi nimi, mida kasutate sõnumite allkirjastamiseks. Vaikimisi: "CN=ChangepointAPICertificate" sertifikaadi nimi.
ISAPI_Mode	ISAPI režiim. Vaikimisi: NT
ISAPI_päis	Päis, mida kasutatakse, kui ISAPI_Mode on "HEADER", ntample, tühi.
Nõude tüüp	Sisestage SSO nõude tüüp. Vaikimisi: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Käivitage konfiguratsiooniskriptid

1. Avage PowerShelli viip.
   Märkus. Kui teie serveris on kasutajakonto kontroll lubatud, peate avama PowerShelli viiba kõrgendatud administraatoriõigustega.
2. Navigeerige CP-sse web teenuse konfiguratsioonikataloog, vaikimisi:
   ConfigurationCPWebTeenindus
3. Käivitage: ./Configuration_SSO_ISAPI.ps1
4. Järgige juhiseid.

SSO konfigureerimine WS-Federation (ADFS 2.0) abil WCF-i jaoks Web Teenused
Stage 1 Koguge konfiguratsiooniparameetrid
Määrake konfiguratsiooniparameetrite väärtused allolevast tabelist. Veenduge, et ADFS_Server_URI oleks lõppkasutaja brauseri sisevõrgu tsoonis.
Märkus. Vaikimisi on Changepoint konfigureeritud avalikustatud võtmete automaatseks värskendamiseks, mida kasutatakse turbelubade allkirjastamiseks, kasutades avaldatud liitmise metaandmete dokumenti. ADFS-is on see:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Mõnel juhul ei pruugi muutumispunktist ADFS-serverisse pääseda web server, nii et peate pärast konfiguratsiooniskripti käivitamist konfiguratsiooni käsitsi värskendama. Lisateavet leiate jaotisest "Avalike võtmete käsitsi värskendamine" lk 12.

Parameeter	Kirjeldus
WebService_Path	Changepoint WCF-i asukoht Web Teenused web rakendus files. Vaikimisi: \API\CP Web Teenused
WebService_URI	Domeeni identifikaator, mida kasutate Changepoint WCF-i jaoks Web Teenused. Näiteksample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Selle sertifikaadi nimi, mida kasutate küpsiste krüptimiseks. Vaikimisi: "CN=ChangepointApiCertificate" sertifikaadi nimi.
ServiceCertificate_Name	Sertifikaadi nimi, mida kasutatakse teenuse autentimiseks sõnumiturberežiimi kasutavatele klientidele. Vaikimisi: "CN=ChangepointApiCertificate" sertifikaadi nimi.
Allkirjastamise sertifikaadi_nimi	Sõnumite allkirjastamiseks kasutatava sertifikaadi nimi. Vaikimisi: kasutatakse sertifikaadi nime "CN=ChangepointApiCertificate".
ADFS_ FederationServiceName	Föderatsiooni teenuse nimi. Nime saamiseks: Käivitage ADFS-serveris ADFS 2.0 halduskonsool. • Valige vasakpoolsest menüüst ADFS 2.0. • Valige toimingupaanil Redigeeri liitmisteenuse atribuute. Föderatsiooniteenuse nimi on vahekaardil Üldine.
Nõude tüüp	SSO nõude tüüp. Vaikimisi on: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Käivitage konfiguratsiooniskriptid
Seadistage websaidid, mis kasutavad konfiguratsiooniparameetrite väärtusi.

1. Avage PowerShelli viip.
   Märkus. Kui teie serveris on kasutajakonto kontroll lubatud, peate avama PowerShelli viiba kõrgendatud administraatoriõigustega.
2. Liikuge vahetuspunktini web teenuse konfiguratsioonikataloog, vaikimisi: ConfigurationCPWebTeenindus
3.  Käivitage: ./Configuration_SSO_ADFS.ps1
4. Järgige juhiseid.

Stage 3 Looge osapoolte usaldus
Looge ADFS 2.0 konsoolis Relying Party Trust.

1. Käivitage oma ADFS-serveris ADFS 2.0 konsool.
2. Valige Toiming > Lisa sõltuva osapoole usaldus.
3. Klõpsake nuppu Start.
4. Valige Internetis või kohalikus võrgus avaldatud usaldusväärse osapoole andmete importimine.
5. Sisestage föderatsiooni metaandmete aadress ja seejärel klõpsake nuppu Edasi, näiteksample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Sisestage kuvatav nimi, nt Changepoint WCF API, ja klõpsake nuppu Edasi, Edasi, Edasi ja seejärel Sule.
7. Lisage ülaltoodud Changepointi sõltuva poole jaoks nõude reegel. Muudatuspunkti jaoks on nõude reegli vaikenimi "UPN".
8. Seostage LDAP-i atribuut “User-Principal-Name” väljamineva nõude tüübiga “* UPN” või “UPN”.

Avalike võtmete käsitsi värskendamine
ADFS-i serveri loa allkirjastamise pisijälje hankimiseks

1. Käivitage ADFS-serveris ADFS 2.0 halduskonsool.
2. Valige Teenus > Sertifikaadid ja topeltklõpsake märgi allkirjastamise sertifikaati.
3. Valige vahekaart Üksikasjad.
4. Valige väli Pöidlajälg.
5. Pöidlajälje väärtuse saamiseks eemaldage kõik tühikud, sealhulgas esimene tühik.

Uuendamiseks Web.config file

1. Redigeerige ADFS-i web.config. Vaikimisi asukoht on:
   EnterpriseRP-STS_ADFS
2. all element, leidke võti ida:FederationMetadataLocation ja tühjendage selle väärtus:
   
3. Under , leidke element ja asendage see järgmisega: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

COM API ühenduse testimine

1. Käivitage API testkomplekt. Vaikimisi asukoht on:
   APIAPI ComponentsApiTestKit.exe.
2. Klõpsake valikul Ühendusstring > Krüpteerija.
3. Väljal Lihtteksti ühenduste string:
   a. Asendage SERVERNAME ja DATABASENAME oma andmebaasi teabega.
   b. Asendage USERID ja PASSWORD oma andmebaasi administraatori kasutajakonto teabega.
   c. Vajadusel sisestage ajalõpu väärtus.
4. Klõpsake Krüpti.
5. Kopeerige tekst väljale Krüpteeritud ühenduse string.
6. Sulgege dialoogiboks.
7. API testikomplekti menüüs klõpsake Ühendus > COM API ühenduse testija.
8. Vahekaardil Praegune versioon kleepige krüptitud ühenduse string väljale Ühendusstring.
9. Sisestage väljadele LoginId ja Password oma Changepointi konto sisselogimise ID ja parool.
10. Väljal Logitase (0–8) määrake COM API logis tagastatava veateabe tase file kui testi tulemus näitab ühenduse probleemi.
    0 = logimine puudub
    1 = Lähteobjekt ja meetod
    2 = Veateade
    3 = Sisendparameetrid
    4 = Tagastab
    5 = Hoiatus
    8 = kontrollpunkt
    Vaikimisi on 8.
11. Klõpsake nuppu Ühenda.
    Kui ühenduse loomine õnnestus, kuvatakse väljal Tulemus eduteade. Kui ühenduse loomine ebaõnnestus, kontrollige COM API logi file vigade eest. Logi vaikekoht file on APIAPILogid.

Installitud API komponentide versiooni kontrollimine
Installitud komponentide, sealhulgas väljalaske versiooni ja tee kohta üksikasjade hankimiseks saate kasutada versioonikontrolli utiliiti.

1. Käivitage CPVersionChecker.exe. Vaikimisi tee on: APIAPI komponendid
2. Klõpsake nuppu Loe.

Versiooni kontrollimine Web Services API

1. Käivitage Internet Explorer serverist, kus Web Services API on installitud ja sisestage aadress:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  kus port on pordi number websait, kuhu CP installisiteWebTeenuse virtuaalne kataloog.
2. WSLogini lehel klõpsake linki GetVersion.
3. Klõpsake nuppu Kutsu.

Testides Web Services API ühendus

1. Käivitage Internet Explorer serverist, kus Web Services API on installitud ja sisestage aadress: http://localhost.port/CPWeb.Service/WSLogin.asmx  kus port on pordi number websait, kuhu CP installisiteWebTeenuse virtuaalne kataloog.
2. WSLogini lehel klõpsake linki TestConnection.
3. Klõpsake nuppu Invoke. 4. Testi tulemustes:

• Kui element on vale, testühendus õnnestus.
• Kui element on tõene, testühendus ebaõnnestus. Lisateabe saamiseks
  teavet rikke põhjuste kohta vt ja testitulemustes ja kontrollige API logisid. API logide vaiketee on: APIAPILogid

Seadistamine Web Services API keeleserveris

1. Changepointi juurutamiseks Web Teenuste API keeleserveris peate lisama või värskendama tag aastal Web Services API web.config. Vaikimisi asukoht Web.config file on: APICP Web TeenusedWeb.config
2. Kui tag juba olemas, veenduge, et nii kultuuri kui ka uiCulture atribuudid oleksid „en-US”.
3. Kui tag pole veel olemas, lisage järgmine , kommenteerida ja elemendidweb> sõlm:web>
   Visual Basicu suvandid: määrake strict=” true”, et keelata kõik andmetüüpide teisendused, mille puhul andmed võivad kaduda. Kõigi muutujate deklareerimise sundimiseks määrake explicit=”true”. ->
4. Taaskäivitage IIS.

Dokumendid / Ressursid

Changepoint API tarkvara [pdf] Paigaldusjuhend API, tarkvara, API tarkvara

Viited

• Kasutusjuhend