API uppsetningarleiðbeiningar
Tilvísunarleiðbeiningar
Breytingapunktur 2021

© 2021 Changepoint Canada ULC Allur réttur áskilinn. BANDARÍSK RÍKISSTJÓRN - Notkun, fjölföldun eða birting bandarískra stjórnvalda er háð takmörkunum eins og settar eru fram í Changepoint Canada ULC leyfissamningnum og eins og kveðið er á um í DFARS 227.7202-1(a) og 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19, eða FAR 52.227-14 (ALT III), eftir því sem við á. Þessi vara inniheldur trúnaðarupplýsingar og viðskiptaleyndarmál Changepoint Canada ULC. Uppljóstrun er bönnuð án fyrirfram skriflegs leyfis Changepoint Canada ULC. Notkun þessarar vöru er háð skilmálum og skilyrðum í leyfissamningi notandans við Changepoint Canada ULC. Aðeins leyfishafi má afrita skjöl til innri notkunar. Ekki má breyta, breyta eða breyta innihaldi þessa skjals nema með skriflegu samþykki Changepoint Canada ULC. Changepoint Canada ULC getur breytt efninu sem tilgreint er hér hvenær sem er, með eða án fyrirvara.

Að setja upp Changepoint API

Um uppsetningu á Changepoint API
Changepoint API er fáanlegt sem COM API, Windows Communication Foundation (WCF) þjónusta og, fyrir afturábak eindrægni, sem Web Þjónusta Enhancements (WSE) þjónusta. Fyrir upplýsingar um Changepoint API, sjá Changepoint API tilvísun. Fyrir uppfærsluskýringar, fyrirvara og þekkt vandamál, sjá útgáfuskýringar í teymismöppum í Changepoint.
Uppfærsla á Changepoint API
Ef þú ert að uppfæra frá fyrri útgáfu af Changepoint, notaðu Windows stjórnborðið til að fjarlægja fyrri útgáfu af Changepoint API og íhlutum þess áður en þú setur upp þessa útgáfu.
Changepoint API kröfur
Þú verður að setja upp Changepoint áður en þú setur upp Changepoint API. Fyrir hugbúnaðarkröfur, sjá Changepoint Software Compatibility Matrix, sem er fáanlegt í 2021 Release Notes and Patches teymumöppunni í Changepoint.
File stígasamþykktir
Í þessu skjali eru eftirfarandi venjur notaðar fyrir algengar leiðir:

• Rótarslóð Changepoint uppsetningunnar.
  Sjálfgefin slóð er:
  C: Dagskrá Files (x86)Breytingapunktur
• Rótarstaðsetning algengra Changepoint tóla, svo sem Innskráningarstillingar tólsins.
  Sjálfgefin slóð er:
  C: Dagskrá Files (x86) Algeng FilesChangepointBreytingapunktur

Að setja upp Changepoint API

1. Frá Changepoint API miðla rót skrá, keyrðu setup.exe.
2. Fylgdu leiðbeiningunum þar til skjárinn Veldu eiginleika birtist.
3. Veldu eiginleikana sem þú vilt setja upp og smelltu síðan á Next.
4. Veldu API áfangastað möppu, sjálfgefið API og smelltu á Next.
   Athugið: Changepoint Login Settings tólið er sett upp í Innskráningarstillingar, óháð áfangamöppunni sem þú tilgreinir.
5. Ef þú valdir Web Þjónusta API: a. Þegar Veldu
   a Web Vefsíðuskjár birtist, veldu a websíðu til að bæta sýndarskránni við og smelltu síðan á Next.
   b. Smelltu á Next til að halda áfram. 6. Þegar uppsetningu API er lokið, smelltu á Ljúka.

Stillir Changepoint API þannig að það sé skyndiminni meðvitað
Til að stilla Changepoint API þannig að það sé skyndiminni meðvitað skaltu skipta út gildunum fyrir „skyndiminni. Lykilorð“ og „skyndiminni. Servers“ lykla í CP Web ÞjónustaWeb.config file með gildunum sem notuð eru í EnterpriseWeb.config file.
Virkjar Web Þjónustuaukning (WSE)

1. Breyttu Web.config file fyrir web þjónusta. Sjálfgefin staðsetning er:
   APICP Web ÞjónustaWeb.config
2. Finndu þrjú tilvik af eftirfarandi athugasemdarlínu:
   < !– Taktu úr athugasemdum við eftirfarandi þátt ef þú ert að nota Web Service Enhancements (WSE) API. Skildu eftir athugasemdir ef þú notar WCF þjónustu og er ekki að setja upp Web Þjónustuaukning (WSE) –>
3. Taktu úr athugasemdum við þáttinn sem kemur á eftir hverju tilviki athugasemdalínu:
   <section name=”microsoft.web.services2″ … >webÞjónusta>web.þjónusta2>
   Athugið: ThewebÞjónusta> þáttur sem á að vera án athugasemda er barn afweb>.

Að stilla skráningu fyrir Web Þjónusta API
Þú verður að stilla log file stig stígs og logs. Logstigin eru uppsöfnuð. Til dæmisample, ef þú tilgreinir stig 3, þá eru stig 1, 2 og 3 skráð. Sjálfgefið logstig er 8.

1. Breyttu web þjónustu Web.config. Sjálfgefin staðsetning er:
   APICP Web ÞjónustaWeb.config
2. Stilltu LogFileLeið. Sjálfgefið gildi er APIAPILogs. 3. Stilltu LogLevel. Gild gildi eru:
   0 = Engin skráning
   1 = Upprunahlutur og aðferð
   2 = Villuboð
   3 = Inntaksfæribreytur
   4 = Skilar
   5 = Viðvörun
   8 = Gæslustöð

Stillir auðkenningu sýndarskrár fyrir Web Þjónusta API
Þú verður að virkja nafnlausan aðgang og slökkva á samþættri Windows auðkenningu fyrir CPWebSýndarskrá þjónustu í Internet Information Services (IIS). Fyrir frekari upplýsingar, sjá Microsoft IIS skjölin.
Stilla gagnagrunnstengingarstillingar fyrir Web Þjónusta API
Notaðu Innskráningarstillingar tólið til að dulkóða gagnagrunnstengingarstillingarnar í Web Þjónusta API Web.config file. Fyrir frekari upplýsingar, leitaðu að „Stilling gagnagrunnstengingarstillinga“ í Changepoint Uppsetningarhandbók.
Stillir auðkenningu fyrir Changepoint WCF Web Þjónusta
Þú getur stillt Authentication Application og Single Sign-On (SSO) fyrir Changepoint WCF Web Þjónusta.
Eftirfarandi útfærsluvalkostir eru fáanlegir með því að nota Secure Token Service (STS):

• SSO með ISAPI SSL valfrjálst
• SSO sem notar WS-Federation (ADFS 2.0) SSL krafist

Ef SSL er krafist tryggir stillingarforritið að það sé notað.
Stillingarforskriftirnar fyrir ISAPI og auðkenningu forrita geta mögulega virkjað SSL.
Stillir auðkenningu forrits fyrir WCF Web Þjónusta
Sjálfgefin auðkenningargerð fyrir Changepoint WCF Web Þjónusta er auðkenning forrita.
Notaðu verklagsreglurnar í þessum hluta til að:

• stilla Changepoint WCF Web Þjónusta til að nota auðkenningu forrita með SSL
• afturkalla Changepoint WCF Web Þjónusta við auðkenningu forrita eftir að hafa innleitt eina af SSO útfærslunum

Stilltu PowerShell

1. Opnaðu Windows PowerShell hvetja.
2. Breyttu framkvæmdarstefnunni:
   Set-ExecutionPolicy ótakmörkuð

Stage 1 Safnaðu stillingarbreytum
Ákvarða gildin fyrir stillingarfæribreyturnar.

Parameter	Lýsing
WebÞjónustuslóð	Staðsetning Changepoint WCF Web Þjónusta web umsókn files. Sjálfgefið: \API\CP Web Þjónusta
Þjónustuskírteini_ Nafn	Nafn vottorðs sem verður notað til að auðkenna þjónustuna fyrir viðskiptavinum með því að nota öryggisstillingu skilaboða. Sjálfgefið: „CN=ChangepointAPICertificate“ heiti skírteinisins.
krefjast HTTPS	Krefjast HTTPS (True/False) Sjálfgefið: False.

Stage 2 Framkvæma stillingarforskriftir
Notaðu gildin fyrir stillingarfæribreytur til að breyta stillingum á websíður.

1.  Opnaðu PowerShell hvetja.
   Athugið: Ef netþjónninn þinn er með notandareikningsstýringu virkt verður þú að opna PowerShell hvetja með auknum stjórnandaheimildum.
2. Farðu í CP web þjónustustillingarskrá, sjálfgefið:
   StillingarCPWebÞjónusta
3.  Keyra ./Configuration_AppAuth.ps1
4. Fylgdu leiðbeiningunum.

Stillir staka innskráningu (SSO) fyrir WCF Web Þjónusta
Stilltu PowerShell

1. Opnaðu Windows PowerShell hvetja.
2. Breyttu framkvæmdarstefnunni:
   Set-ExecutionPolicy ótakmörkuð

Stillir SSO með ISAPI fyrir WCF Web Þjónusta
Stage 1 Safnaðu stillingarbreytum
Ákvarðu gildin fyrir eftirfarandi stillingarfæribreytur.

Parameter	Lýsing
WebÞjónustuslóð	Staðsetning Changepoint WCF Web Þjónusta web umsókn files. Sjálfgefið: \API\CP Web Þjónusta
krefjast HTTPS	Krefjast HTTPS (True/False). Sjálfgefið: False.
Changepoint_RSA_ Cookie_Transform	Heiti vottorðsins sem þú notar fyrir dulkóðun á vafrakökum. Sjálfgefið: „CN=ChangepointAPICertificate“ heiti skírteinisins.
ServiceCertificate_Name	Sláðu inn heiti vottorðsins sem verður notað til að auðkenna þjónustuna fyrir viðskiptavinum með því að nota skilaboðaöryggisstillingu. Sjálfgefið: „CN=ChangepointAPICertificate“ heiti skírteinisins.
SigningCertificate_Name	Sláðu inn heiti undirritunarvottorðsins. Þetta er nafnið á vottorðinu sem þú notar til að undirrita skilaboð. Sjálfgefið: „CN=ChangepointAPICertificate“ heiti skírteinisins.
ISAPI_Mode	ISAPI hamurinn. Sjálfgefið: NT
ISAPI_Header	Hausinn notaður þegar ISAPI_Mode er „HEADER“, til dæmisample, tómur.
ClaimType	Sláðu inn SSO kröfugerðina. Sjálfgefið: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Framkvæma stillingarforskriftir

1. Opnaðu PowerShell hvetja.
   Athugið: Ef netþjónninn þinn er með notandareikningsstýringu virkt verður þú að opna PowerShell hvetja með auknum stjórnandaheimildum.
2. Farðu í CP web þjónustustillingarskrá, sjálfgefið:
   StillingarCPWebÞjónusta
3. Keyra: ./Configuration_SSO_ISAPI.ps1
4. Fylgdu leiðbeiningunum.

Stilla SSO með WS-Federation (ADFS 2.0) fyrir WCF Web Þjónusta
Stage 1 Safnaðu stillingarbreytum
Ákvarðu gildin fyrir stillingarfæribreyturnar í töflunni hér að neðan. Gakktu úr skugga um að ADFS_Server_URI sé á innra netsvæðinu í vafra notanda.
Athugið: Sjálfgefið er Changepoint stillt til að uppfæra sjálfkrafa opinberu lyklana sem eru notaðir til að undirrita öryggistákn með því að nota útgefið lýsigagnaskjal sambandsins. Í ADFS er þetta:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Í sumum tilfellum getur verið að það sé ekki hægt að ná í ADFS netþjóninn frá Changepoint web miðlara þannig að þú verður að uppfæra stillingarnar handvirkt eftir að hafa keyrt uppsetningarforskriftina. Fyrir frekari upplýsingar, sjá "Opinber lyklar handvirkt uppfæra" á síðu 12.

Parameter	Lýsing
WebÞjónustuslóð	Staðsetning Changepoint WCF Web Þjónusta web umsókn files. Sjálfgefið: \API\CP Web Þjónusta
WebÞjónusta_URI	Lénaauðkenni sem þú notar fyrir Changepoint WCF Web Þjónusta. Til dæmisample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Heiti vottorðsins sem þú notar fyrir dulkóðun á vafrakökum. Sjálfgefið: „CN=ChangepointApiCertificate“ heiti skírteinisins.
ServiceCertificate_Name	Nafn vottorðs sem verður notað til að auðkenna þjónustuna fyrir viðskiptavinum með því að nota öryggisstillingu skilaboða. Sjálfgefið: „CN=ChangepointApiCertificate“ heiti skírteinisins.
SigningCertificate_Name	Heiti vottorðsins sem þú notar til að undirrita skilaboð. Sjálfgefið: „CN=ChangepointApiCertificate“ vottorðsheitið er notað.
ADFS_ FederationServiceName	Nafn sambandsþjónustu. Til að fá nafnið: Frá ADFS þjóninum, Ræstu ADFS 2.0 stjórnborðið. •Veldu ADFS 2.0 í vinstri valmyndinni. •Í aðgerðaglugganum velurðu Edit Federation Service Properties. Nafn sambandsþjónustunnar er á flipanum Almennt.
ClaimType	SSO kröfugerð. Sjálfgefið er: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Framkvæma stillingarforskriftir
Stilltu websíður sem nota gildin fyrir stillingarfæribreyturnar.

1. Opnaðu PowerShell hvetja.
   Athugið: Ef netþjónninn þinn er með notandareikningsstýringu virkt verður þú að opna PowerShell hvetja með auknum stjórnandaheimildum.
2. Farðu í Changepoint web þjónustustillingarskrá, sjálfgefið: StillingarCPWebÞjónusta
3.  Keyra: ./Configuration_SSO_ADFS.ps1
4. Fylgdu leiðbeiningunum.

Stage 3 Skapa traust aðila
Búðu til traust aðila í ADFS 2.0 stjórnborðinu.

1. Ræstu ADFS 2.0 stjórnborðið á ADFS þjóninum þínum.
2. Veldu Action > Add Relying Party Trust.
3. Smelltu á Start.
4. Veldu Flytja inn gögn um trausta aðila sem birt eru á netinu eða á staðarneti.
5. Sláðu inn lýsigögn sambandsins og smelltu síðan á Next, til dæmisample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Sláðu inn skjánafn, td Changepoint WCF API, og smelltu á Next, Next, Next, svo Close.
7. Bættu við kröfureglu fyrir ofangreindan Changepoint Relying Party. Fyrir Changepoint er sjálfgefið heiti kröfureglunnar „UPN“.
8. Tengdu LDAP eigindina „Notanda-Principal-Name“ við útgående kröfugerð „* UPN“ eða „UPN“.

Handvirkt uppfærsla almenningslykla
Til að fá ADFS Server Token Signing Thumbprint

1. Ræstu ADFS 2.0 stjórnborðið frá ADFS þjóninum.
2. Veldu Þjónusta > Vottorð og tvísmelltu á tákn undirritunarvottorðsins.
3. Veldu flipann Upplýsingar.
4. Veldu reitinn Thumbprint.
5. Til að fá þumalputtagildið skaltu fjarlægja öll bilin, þar með talið fyrsta bilið.

Til að uppfæra Web.config file

1. Breyttu ADFS web.config. Sjálfgefin staðsetning er:
   EnterpriseRP-STS_ADFS
2. Undir frumefni, finndu ida:FederationMetadataLocation lykilinn og hreinsaðu gildi hans:
   
3. Undir , Finndu frumefni og skiptu því út fyrir eftirfarandi: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust“ />

Er að prófa COM API tenginguna

1. Keyra API Test Kit. Sjálfgefin staðsetning er:
   APIAPI ComponentsApiTestKit.exe.
2. Smelltu á Tengingarstreng > Dulkóðari.
3. Í reitnum Plain Text Connections String:
   a. Skiptu um SERVERNAME og DATABASENAME fyrir gagnagrunnsupplýsingarnar þínar.
   b. Skiptu um USERID og LYKILORÐ með upplýsingum um notandareikning gagnagrunnsstjórans þíns.
   c. Sláðu inn tímamörk eftir þörfum.
4. Smelltu á Dulkóða.
5. Afritaðu textann í reitnum Dulkóðaður tengingarstrengur.
6. Lokaðu glugganum.
7. Á API Test Kit valmyndinni, smelltu á Connection > COM API Connection Tester.
8. Á flipanum Núverandi útgáfa skaltu líma dulkóðaða tengistrenginn í reitinn Tengingarstrengur.
9. Í LoginId og Password reitina skaltu slá inn innskráningarauðkenni og lykilorð fyrir Changepoint reikninginn þinn.
10. Í Loglevel (0-8) reitnum, tilgreinið hversu villuupplýsingar á að skila í COM API log file ef prófunarniðurstaðan sýnir vandamál með tenginguna.
    0 = Engin skráning
    1 = Upprunahlutur og aðferð
    2 = Villuboð
    3 = Inntaksfæribreytur
    4 = Skilar
    5 = Viðvörun
    8 = Gæslustöð
    Sjálfgefið er 8.
11. Smelltu á Tengjast.
    Ef tengingin tókst birtast skilaboð um árangur í reitnum Niðurstaða. Ef tengingin mistókst skaltu athuga COM API log file fyrir villur. Sjálfgefin staðsetning skrárinnar file er APIAPILógs.

Athugar útgáfu uppsettra API íhluta
Þú getur notað útgáfutékkunartólið til að fá upplýsingar um uppsetta íhluti, þar á meðal útgáfuútgáfuna og slóðina.

1. Keyrðu CPVersionChecker.exe. Sjálfgefin slóð er: APIAPI íhlutir
2. Smelltu á Lesa.

Athugaðu útgáfuna af Web Þjónusta API

1. Ræstu Internet Explorer frá þjóninum þar sem Web Services API er sett upp og sláðu inn heimilisfangið:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  þar sem port er gáttarnúmer á websíðuna þar sem þú settir upp CPWebSýndarskrá þjónustu.
2. Á WSLogin síðunni, smelltu á GetVersion hlekkinn.
3. Smelltu á Kalla.

Er að prófa Web Þjónusta API tenging

1. Ræstu Internet Explorer frá þjóninum þar sem Web Services API er sett upp og sláðu inn heimilisfangið: http://localhost.port/CPWeb.Service/WSLogin.asmx  þar sem port er gáttarnúmer á websíðuna þar sem þú settir upp CPWebSýndarskrá þjónustu.
2. Á WSLogin síðunni smelltu á TestConnection hlekkinn.
3. Smelltu á Kalla. 4. Í niðurstöðum prófsins:

• Ef þátturinn er rangur, prófunartengingin tókst.
• Ef þátturinn er satt, prófunartengingin mistókst. Fyrir meira
  upplýsingar um ástæður bilunarinnar, sjá og þættir í prófunarniðurstöðum og athugaðu API logs. Sjálfgefin slóð að API logs er: APIAPILogs

Að setja upp Web Þjónusta API á tungumálaþjóni

1. Til að dreifa Changepoint Web Þjónusta API á tungumálaþjóni, þú verður að bæta við eða uppfæra tag í Web Þjónusta API web.config. Sjálfgefin staðsetning Web.config file er: APICP Web ÞjónustaWeb.config
2. Ef tag er þegar til, tryggja að bæði menning og uiCulture eiginleikar séu „en-US“.
3. Ef tag er ekki þegar til, bætið eftirfarandi við , athugasemd og þættir íweb> hnútur:web>
   Visual Basic valkostir: Stilltu strict=“ true” til að banna allar gagnategundabreytingar þar sem gagnatap getur átt sér stað. Stilltu explicit=“true” til að þvinga fram yfirlýsingu allra breyta. –>
4. Endurræstu IIS.

Skjöl / auðlindir

Changepoint API hugbúnaður [pdfUppsetningarleiðbeiningar API, hugbúnaður, API hugbúnaður

Heimildir

• Notendahandbók