API diegimo vadovas
Nuorodų vadovas
Pokyčių taškas 2021 m

© 2021 Changepoint Canada ULC Visos teisės saugomos. JAV VYRIAUSYBĖS TEISĖS – JAV vyriausybės atliekamam naudojimui, kopijavimui ar atskleidimui taikomi apribojimai, nustatyti Changepoint Canada ULC licencijos sutartyje ir kaip numatyta DFARS 227.7202-1(a) ir 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (1988 m. spalio mėn.), FAR 12.212(a) (1995), FAR 52.227-19 arba FAR 52.227-14 (ALT III). Šiame gaminyje yra konfidencialios informacijos ir „Changepoint Canada ULC“ komercinių paslapčių. Atskleidimas draudžiamas be išankstinio aiškaus raštiško „Changepoint Canada ULC“ leidimo. Šio gaminio naudojimui taikomos vartotojo licencijos sutarties su Changepoint Canada ULC sąlygos. Dokumentaciją gali atgaminti tik Licenciatas vidiniam naudojimui. Šio dokumento turinys negali būti keičiamas, modifikuojamas ar keičiamas be aiškaus raštiško Changepoint Canada ULC sutikimo. Changepoint Canada ULC gali pakeisti čia nurodytą turinį bet kuriuo metu, su įspėjimu arba be jo.

„Changepoint“ API diegimas

Apie „Changepoint“ API diegimą
„Changepoint“ API galima kaip COM API, „Windows Communication Foundation“ (WCF) paslaugą ir, siekiant atgalinio suderinamumo, kaip Web Paslaugų patobulinimų (WSE) paslauga. Norėdami gauti informacijos apie „Changepoint API“, žr. „Changepoint API“ nuorodą. Norėdami sužinoti naujinimo pastabas, įspėjimus ir žinomas problemas, žr. „Changepoint“ komandos aplankų laidos pastabas.
„Changepoint“ API atnaujinimas
Jei atnaujinate ankstesnį „Changepoint“ leidimą, prieš diegdami šią versiją naudokite „Windows“ valdymo skydelį, kad pašalintumėte ankstesnę „Changepoint“ API versiją ir jos komponentus.
Changepoint API reikalavimai
Prieš diegdami Changepoint API, turite įdiegti „Changepoint“. Dėl programinės įrangos reikalavimų žr. „Changepoint“ programinės įrangos suderinamumo matricą, kuri yra „Changepoint“ 2021 m. laidos pastabų ir pataisų komandos aplanke.
File kelio konvencijos
Šiame dokumente bendriems maršrutams naudojamos šios sutartys:

• Pagrindinis „Changepoint“ diegimo kelias.
  Numatytasis kelias yra:
  C: Programa Files (x86)ChangepointChangepoint
• Įprastų „Changepoint“ paslaugų, pvz., prisijungimo nustatymų priemonės, šakninė vieta.
  Numatytasis kelias yra:
  C: Programa Files (x86) Dažnas FilesChangepointChangepoint

„Changepoint“ API diegimas

1. „Changepoint API“ medijos šakniniame kataloge paleiskite setup.exe.
2. Vykdykite raginimus, kol pasirodys ekranas Select Features.
3. Pasirinkite funkcijas, kurias norite įdiegti, tada spustelėkite Pirmyn.
4. Pasirinkite API paskirties aplanką, numatytąjį API ir spustelėkite Pirmyn.
   Pastaba: Įdiegta „Changepoint“ prisijungimo nustatymų programa LoginSettings, neatsižvelgiant į jūsų nurodytą paskirties aplanką.
5. Jei pasirinkote Web Paslaugų API: a. Kai Pasirinkti
   a Web Pasirodo svetainės ekranas, pasirinkite a websvetainę, į kurią norite įtraukti virtualųjį katalogą, tada spustelėkite Pirmyn.
   b. Norėdami tęsti, spustelėkite Pirmyn. 6. Kai API diegimas baigtas, spustelėkite Baigti.

„Changepoint“ API konfigūravimas, kad būtų atsižvelgta į talpyklą
Norėdami sukonfigūruoti „Changepoint“ API, kad ji žinotų talpyklą, pakeiskite „cache. Slaptažodis“ ir „talpykla. Serveriai“ klavišus CP Web PaslaugosWeb.config file su įmonėje naudojamomis reikšmėmisWeb.config file.
Įgalinimas Web Paslaugų patobulinimai (WSE)

1. Redaguoti Web.config file už web paslaugos. Numatytoji vieta yra:
   APICP Web PaslaugosWeb.config
2. Raskite tris šios komentaro eilutės atvejus:
   < !– Jei naudojate, panaikinkite šio elemento komentarą Web Service Enhancements (WSE) API. Palikite komentarus, jei naudojatės WCF paslaugomis ir nediegiate Web Paslaugų patobulinimai (WSE) –>
3. Panaikinkite elemento, esančio po kiekvieno komentaro eilutės atvejo, komentarą:
   <section name=”microsoft.web.services2″ … >webPaslaugos>web.services2>
   Pastaba: ThewebPaslaugos> elementas, kurį reikia nekomentuoti, yra antrinis elementasweb>.

Registravimo konfigūravimas Web Paslaugų API
Turite nustatyti žurnalą file kelio ir žurnalo lygiai. Žurnalo lygiai yra kaupiami. Pavyzdžiui,ample, jei nurodote 3 lygį, registruojami 1, 2 ir 3 lygiai. Numatytasis žurnalo lygis yra 8.

1. Redaguoti web paslaugas Web.config. Numatytoji vieta yra:
   APICP Web PaslaugosWeb.config
2. Nustatykite žurnaląFileKelias. Numatytoji reikšmė yra APIAPILlogai. 3. Nustatykite LogLevel. Galiojančios vertės yra šios:
   0 = Neregistruojama
   1 = šaltinio objektas ir metodas
   2 = Klaidos pranešimas
   3 = įvesties parametrai
   4 = Grąžina
   5 = Įspėjimas
   8 = Kontrolinis taškas

Konfigūruojamas virtualaus katalogo autentifikavimas Web Paslaugų API
Turite įjungti anoniminę prieigą ir išjungti integruotą Windows autentifikavimą CPWebPaslaugų virtualus katalogas Interneto informacijos tarnybose (IIS). Daugiau informacijos rasite Microsoft IIS dokumentacijoje.
Konfigūruojami duomenų bazės ryšio parametrai Web Paslaugų API
Norėdami užšifruoti duomenų bazės ryšio parametrus, naudokite Prisijungimo nustatymų įrankį Web Paslaugų API Web.config file. Norėdami gauti daugiau informacijos, „Changepoint“ diegimo vadove ieškokite „Duomenų bazės ryšio nustatymų konfigūravimas“.
„Changepoint WCF“ autentifikavimo konfigūravimas Web Paslaugos
Galite konfigūruoti programos autentifikavimą ir vienkartinį prisijungimą (SSO), skirtą „Changepoint WCF“. Web Paslaugos.
Naudojant Secure Token Service (STS) galimos šios diegimo parinktys:

• SSO naudojant ISAPI SSL neprivaloma
• SSO naudojant WS-Federation (ADFS 2.0) Reikalingas SSL

Jei reikalingas SSL, konfigūracijos scenarijus užtikrina, kad jis būtų naudojamas.
ISAPI ir programos autentifikavimo konfigūracijos scenarijai gali pasirinktinai įgalinti SSL.
Programos autentifikavimo konfigūravimas WCF Web Paslaugos
Numatytasis „Changepoint WCF“ autentifikavimo tipas Web Paslaugos yra programos autentifikavimas.
Naudokite šiame skyriuje nurodytas procedūras, kad:

• konfigūruoti Changepoint WCF Web Paslaugos, skirtos naudoti programų autentifikavimą su SSL
• grąžinti Changepoint WCF Web Programos autentifikavimo paslaugos įdiegus vieną iš SSO diegimų

Konfigūruokite „PowerShell“.

1. Atidarykite „Windows PowerShell“ raginimą.
2. Pakeiskite vykdymo politiką:
   Set-ExecutionPolicy Neribota

Stage 1 Surinkite konfigūracijos parametrus
Nustatykite konfigūracijos parametrų reikšmes.

Parametras	Aprašymas
WebPaslaugos_kelias	„Changepoint WCF“ vieta Web Paslaugos web taikymas files. Numatytas: \API\CP Web Paslaugos
Paslaugos sertifikatas_ Vardas	Sertifikato pavadinimas, kuris bus naudojamas autentifikuojant paslaugą klientams naudojant pranešimų saugos režimą. Numatytasis: „CN=ChangepointAPICertificate“ sertifikato pavadinimas.
reikia HTTPS	Reikalauti HTTPS (tiesa / klaidinga) Numatytoji: klaidinga.

Stage 2 Vykdykite konfigūracijos scenarijus
Naudokite konfigūracijos parametrų reikšmes, kad pakeistumėte konfigūraciją websvetaines.

1.  Atidarykite „PowerShell“ raginimą.
   Pastaba: Jei jūsų serveryje įgalintas vartotojo abonemento valdymas, turite atidaryti „PowerShell“ raginimą naudodami padidintus administratoriaus leidimus.
2. Eikite į CP web paslaugų konfigūracijos katalogas, numatytasis:
   ConfigurationCPWebAptarnavimas
3.  Vykdykite ./Configuration_AppAuth.ps1
4. Vykdykite nurodymus.

Vieno prisijungimo (SSO) konfigūravimas WCF Web Paslaugos
Konfigūruokite „PowerShell“.

1. Atidarykite „Windows PowerShell“ raginimą.
2. Pakeiskite vykdymo politiką:
   Set-ExecutionPolicy Neribota

SSO konfigūravimas naudojant ISAPI, skirtą WCF Web Paslaugos
Stage 1 Surinkite konfigūracijos parametrus
Nustatykite šių konfigūracijos parametrų reikšmes.

Parametras	Aprašymas
WebPaslaugos_kelias	„Changepoint WCF“ vieta Web Paslaugos web taikymas files. Numatytas: \API\CP Web Paslaugos
reikia HTTPS	Reikalauti HTTPS (tiesa / klaidinga). Numatytoji: klaidinga.
Changepoint_RSA_ Cookie_Transform	Sertifikato, kurį naudojate slapukų šifravimui, pavadinimas. Numatytasis: „CN=ChangepointAPICertificate“ sertifikato pavadinimas.
ServiceCertificate_Name	Įveskite sertifikato pavadinimą, kuris bus naudojamas autentifikuoti paslaugą klientams naudojant pranešimų saugos režimą. Numatytasis: „CN=ChangepointAPICertificate“ sertifikato pavadinimas.
SigningCertificate_Name	Įveskite pasirašymo sertifikato pavadinimą. Tai sertifikato, kurį naudojate laiškams pasirašyti, pavadinimas. Numatytasis: „CN=ChangepointAPICertificate“ sertifikato pavadinimas.
ISAPI_Mode	ISAPI režimas. Numatytasis: NT
ISAPI_Header	Antraštė naudojama, kai ISAPI_Mode yra „HEADER“, pvz.,ample, tuščia.
ClaimType	Įveskite SSO paraiškos tipą. Numatytasis: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Vykdykite konfigūracijos scenarijus

1. Atidarykite „PowerShell“ raginimą.
   Pastaba: Jei jūsų serveryje įgalintas vartotojo abonemento valdymas, turite atidaryti „PowerShell“ raginimą naudodami padidintus administratoriaus leidimus.
2. Eikite į CP web paslaugų konfigūracijos katalogas, numatytasis:
   ConfigurationCPWebAptarnavimas
3. Vykdykite: ./Configuration_SSO_ISAPI.ps1
4. Vykdykite nurodymus.

SSO konfigūravimas naudojant WS-Federation (ADFS 2.0) WCF Web Paslaugos
Stage 1 Surinkite konfigūracijos parametrus
Žemiau esančioje lentelėje nustatykite konfigūracijos parametrų reikšmes. Įsitikinkite, kad ADFS_Server_URI yra galutinio vartotojo naršyklės intraneto zonoje.
Pastaba: Pagal numatytuosius nustatymus „Changepoint“ yra sukonfigūruotas automatiškai atnaujinti viešuosius raktus, naudojamus pasirašyti saugos prieigos raktus, naudojant paskelbtą susijungimo metaduomenų dokumentą. ADFS tai yra:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Kai kuriais atvejais gali nepavykti pasiekti ADFS serverio iš keitimo taško web serverį, todėl paleidę konfigūracijos scenarijų turėsite rankiniu būdu atnaujinti konfigūraciją. Norėdami gauti daugiau informacijos, žr. „Viešųjų raktų atnaujinimas rankiniu būdu“ 12 puslapyje.

Parametras	Aprašymas
WebPaslaugos_kelias	„Changepoint WCF“ vieta Web Paslaugos web taikymas files. Numatytas: \API\CP Web Paslaugos
WebPaslaugos_URI	Domeno identifikatorius, kurį naudojate „Changepoint WCF“. Web Paslaugos. Pavyzdžiui,ample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Sertifikato, kurį naudojate slapukų šifravimui, pavadinimas. Numatytasis: „CN=ChangepointApiCertificate“ sertifikato pavadinimas.
ServiceCertificate_Name	Sertifikato pavadinimas, kuris bus naudojamas autentifikuojant paslaugą klientams naudojant pranešimų saugos režimą. Numatytasis: „CN=ChangepointApiCertificate“ sertifikato pavadinimas.
SigningCertificate_Name	Sertifikato, kurį naudojate laiškams pasirašyti, pavadinimas. Numatytasis: naudojamas „CN=ChangepointApiCertificate“ sertifikato pavadinimas.
ADFS_ FederationServiceName	Federacijos tarnybos pavadinimas. Norėdami gauti pavadinimą: ADFS serveryje paleiskite ADFS 2.0 valdymo konsolę. • Kairiajame meniu pasirinkite ADFS 2.0. • Veiksmų srityje pasirinkite Redaguoti susiejimo paslaugų ypatybes. Federacijos tarnybos pavadinimas yra skirtuke Bendra.
ClaimType	SSO paraiškos tipas. Numatytasis yra: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Vykdykite konfigūracijos scenarijus
Konfigūruokite websvetainėse, naudojant konfigūracijos parametrų reikšmes.

1. Atidarykite „PowerShell“ raginimą.
   Pastaba: Jei jūsų serveryje įgalintas vartotojo abonemento valdymas, turite atidaryti „PowerShell“ raginimą naudodami padidintus administratoriaus leidimus.
2. Eikite į keitimo tašką web paslaugų konfigūracijos katalogas, numatytasis: ConfigurationCPWebAptarnavimas
3.  Vykdykite: ./Configuration_SSO_ADFS.ps1
4. Vykdykite nurodymus.

Stage 3 Sukurkite patikimą šalies pasitikėjimą
Sukurkite patikimos šalies pasitikėjimą ADFS 2.0 konsolėje.

1. ADFS serveryje paleiskite ADFS 2.0 konsolę.
2. Pasirinkite Veiksmas > Pridėti pasitikinčios šalies pasitikėjimą.
3. Spustelėkite Pradėti.
4. Pasirinkite Importuoti duomenis apie pasitikinčią šalį, paskelbtą internete arba vietiniame tinkle.
5. Įveskite Federacijos metaduomenų adresą, tada spustelėkite Pirmyn, pvzampLe:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Įveskite rodomą pavadinimą, pvz., Changepoint WCF API, ir spustelėkite Kitas, Kitas, Kitas, tada Uždaryti.
7. Pridėkite pretenzijos taisyklę aukščiau nurodytai „Changepoint“ priklausomai šaliai. Pakeitimo taške numatytasis pretenzijos taisyklės pavadinimas yra „UPN“.
8. Susiekite LDAP atributą „User-Principal-Name“ su Outgoing Claim Type „* UPN“ arba „UPN“.

Rankinis viešųjų raktų atnaujinimas
Norėdami gauti ADFS serverio prieigos rakto pasirašymo atspaudą

1. Iš ADFS serverio paleiskite ADFS 2.0 valdymo konsolę.
2. Pasirinkite Paslauga > Sertifikatai ir dukart spustelėkite Žetono pasirašymo sertifikatą.
3. Pasirinkite skirtuką Išsami informacija.
4. Pasirinkite lauką Thumbprint.
5. Norėdami gauti nykščio atspaudo reikšmę, pašalinkite visus tarpus, įskaitant pirmąjį tarpą.

Norėdami atnaujinti Web.config file

1. Redaguokite ADFS web.config. Numatytoji vieta yra:
   EnterpriseRP-STS_ADFS
2. Pagal elementą, suraskite ida:FederationMetadataLocation raktą ir išvalykite jo reikšmę:
   
3. Pagal , Surask elementą ir pakeiskite jį taip: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust“ />

COM API ryšio testavimas

1. Paleiskite API testavimo rinkinį. Numatytoji vieta yra:
   APIAPI ComponentsApiTestKit.exe.
2. Spustelėkite Ryšio eilutė > Šifruotojas.
3. Lauke Paprasto teksto jungčių eilutė:
   a. Pakeiskite SERVERNAME ir DATABASENAME savo duomenų bazės informacija.
   b. Pakeiskite USERID ir PASSWORD savo duomenų bazės administratoriaus vartotojo abonemento informacija.
   c. Jei reikia, įveskite skirtojo laiko reikšmę.
4. Spustelėkite Šifruoti.
5. Lauke Encrypted Connection String nukopijuokite tekstą.
6. Uždarykite dialogo langą.
7. API testavimo rinkinio meniu spustelėkite Ryšys > COM API ryšio testeris.
8. Skirtuke Dabartinė versija įklijuokite šifruotą ryšio eilutę į lauką Ryšio eilutė.
9. Laukuose LoginId ir Password įveskite savo „Changepoint“ paskyros prisijungimo ID ir slaptažodį.
10. Lauke Loglevel (0–8) nurodykite klaidos informacijos, kuri turi būti grąžinta COM API žurnale, lygį file jei bandymo rezultatas rodo ryšio problemą.
    0 = Neregistruojama
    1 = šaltinio objektas ir metodas
    2 = Klaidos pranešimas
    3 = įvesties parametrai
    4 = Grąžina
    5 = Įspėjimas
    8 = Kontrolinis taškas
    Numatytasis yra 8.
11. Spustelėkite Prisijungti.
    Jei ryšys buvo sėkmingas, lauke Rezultatas rodomas sėkmės pranešimas. Jei nepavyko prisijungti, patikrinkite COM API žurnalą file už klaidas. Numatytoji žurnalo vieta file yra APIAPILlogai.

Tikrinama įdiegtų API komponentų versija
Norėdami gauti išsamios informacijos apie įdiegtus komponentus, įskaitant leidimo versiją ir kelią, galite naudoti versijų tikrinimo priemonę.

1. Paleiskite CPVersionChecker.exe. Numatytasis kelias yra: APIAPI komponentai
2. Spustelėkite Skaityti.

Tikrinama versija Web Paslaugų API

1. Paleiskite „Internet Explorer“ iš serverio, kuriame Web Paslaugų API yra įdiegta ir įveskite adresą:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  kur prievadas yra prievado numeris websvetainę, kurioje įdiegėte CPWebPaslaugų virtualus katalogas.
2. WSLogin puslapyje spustelėkite nuorodą GetVersion.
3. Spustelėkite Iškviesti.

Išbandydami Web Paslaugų API ryšys

1. Paleiskite „Internet Explorer“ iš serverio, kuriame Web Paslaugų API yra įdiegta ir įveskite adresą: http://localhost.port/CPWeb.Service/WSLogin.asmx  kur prievadas yra prievado numeris websvetainę, kurioje įdiegėte CPWebPaslaugų virtualus katalogas.
2. WSLogin puslapyje spustelėkite nuorodą TestConnection.
3. Spustelėkite Iškviesti. 4. Bandymo rezultatuose:

• Jeigu elementas klaidingas, bandomasis ryšys pavyko.
• Jeigu elementas teisingas, bandomasis ryšys nepavyko. Daugiau
  informaciją apie gedimo priežastis žr ir elementų bandymo rezultatuose ir patikrinkite API žurnalus. Numatytasis kelias į API žurnalus yra: APIAPILlogai

Nustatant Web Paslaugų API kalbos serveryje

1. Norėdami įdiegti „Changepoint“. Web Paslaugų API kalbos serveryje, turite pridėti arba atnaujinti tag esančiame Web Paslaugų API web.config. Numatytoji vieta Web.config file yra: APICP Web PaslaugosWeb.config
2. Jei tag jau egzistuoja, įsitikinkite, kad kultūros ir uCulture atributai yra „en-US“.
3. Jei tag dar neegzistuoja, pridėkite toliau pateiktą informaciją , komentuoti ir elementai prieweb> mazgas:web>
   „Visual Basic“ parinktys: nustatykite strict=” true“, kad neleistumėte visų duomenų tipų konvertavimo, kai gali būti prarasti duomenys. Norėdami priversti deklaruoti visus kintamuosius, nustatykite explicit=”true”. –>
4. Iš naujo paleiskite IIS.

Dokumentai / Ištekliai

Changepoint API programinė įranga [pdf] Įdiegimo vadovas API, programinė įranga, API programinė įranga

Nuorodos

• Vartotojo vadovas