Canllaw Gosod API
Canllaw Cyfeirio
Newid pwynt 2021

© 2021 Changepoint Canada ULC Cedwir pob hawl. HAWLIAU LLYWODRAETH YR UD - Mae defnydd, dyblygu, neu ddatgeliad gan Lywodraeth yr UD yn ddarostyngedig i gyfyngiadau fel y nodir yng nghytundeb trwydded ULC Changepoint Canada ac fel y darperir yn DFARS 227.7202-1(a) a 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, neu FAR 52.227-14 (ALT III), fel y bo'n berthnasol. Mae'r cynnyrch hwn yn cynnwys gwybodaeth gyfrinachol a chyfrinachau masnach Changepoint Canada ULC. Gwaherddir datgelu heb ganiatâd ysgrifenedig penodol ymlaen llaw gan Changepoint Canada ULC. Mae defnyddio'r cynnyrch hwn yn amodol ar delerau ac amodau Cytundeb Trwydded y defnyddiwr gyda Changepoint Canada ULC. Dim ond y Trwyddedai all atgynhyrchu dogfennau at ddefnydd mewnol. Ni cheir newid, addasu na newid cynnwys y ddogfen hon heb ganiatâd ysgrifenedig pendant Changepoint Canada ULC. Gall Changepoint Canada ULC newid y cynnwys a nodir yma ar unrhyw adeg, gyda rhybudd neu heb rybudd.

Gosod yr API Changepoint

Ynglŷn â gosod yr API Changepoint
Mae'r API Changepoint ar gael fel API COM, gwasanaeth Windows Communication Foundation (WCF) ac, ar gyfer cydweddoldeb tuag yn ôl, fel Web Gwasanaeth Gwella Gwasanaethau (WSE). I gael gwybodaeth am yr API Changepoint, gweler Cyfeirnod API Changepoint. Ar gyfer nodiadau uwchraddio, cafeatau a materion hysbys, gweler y Nodiadau Rhyddhau mewn ffolderi tîm yn Changepoint.
Uwchraddio'r API Changepoint
Os ydych chi'n uwchraddio o ddatganiad blaenorol o Changepoint, defnyddiwch y Panel Rheoli Windows i ddadosod y fersiwn flaenorol o'r API Changepoint a'i gydrannau cyn gosod y fersiwn hon.
Gofynion API Changepoint
Rhaid i chi osod Changepoint cyn i chi osod yr API Changepoint. Ar gyfer gofynion meddalwedd, gweler Matrics Cydnawsedd Meddalwedd Changepoint, sydd ar gael yn ffolder tîm Nodiadau Rhyddhau a Chlytiau 2021 yn Changepoint.
File confensiynau llwybrau
Drwy gydol y ddogfen hon, defnyddir y confensiynau canlynol ar gyfer llwybrau cyffredin:

• Llwybr gwraidd y gosodiad Changepoint.
  Y llwybr rhagosodedig yw:
  C: Rhaglen Files (x86)ChangepointChangepoint
• Y lleoliad gwraidd ar gyfer cyfleustodau Changepoint cyffredin, fel y cyfleustodau Gosodiadau Mewngofnodi.
  Y llwybr rhagosodedig yw:
  C: Rhaglen Files (x86) Cyffredin FilesChangepointChangepoint

Gosod yr API Changepoint

1. O gyfeiriadur gwraidd cyfryngau API Changepoint, rhedeg setup.exe.
2. Dilynwch yr awgrymiadau nes bod y sgrin Dewiswch Nodweddion yn ymddangos.
3. Dewiswch y nodweddion rydych chi am eu gosod, yna cliciwch ar Next.
4. Dewiswch y ffolder cyrchfan API, rhagosodedig API, a chliciwch ar Next.
   Nodyn: Mae cyfleustodau Gosodiadau Mewngofnodi Changepoint wedi'i osod i mewn LoginSettings, waeth beth fo'r ffolder cyrchfan rydych chi'n ei nodi.
5. Os dewisoch chi'r Web API Gwasanaethau: a. Pan fydd y Dewis
   a Web Sgrin safle yn ymddangos, dewiswch a websafle i ychwanegu'r cyfeiriadur rhithwir ato, ac yna cliciwch ar Next.
   b. Cliciwch Nesaf i barhau. 6. Pan fydd gosod yr API wedi'i gwblhau, cliciwch Gorffen.

Ffurfweddu'r API Changepoint i fod yn ymwybodol o'r storfa
I ffurfweddu'r API Changepoint i fod yn ymwybodol o storfa, disodli'r gwerthoedd ar gyfer y “cache. Cyfrinair" a "cache. Allweddi gweinyddwyr yn y CP Web GwasanaethauWeb.config file gyda'r gwerthoedd a ddefnyddir yn y FenterWeb.config file.
Galluogi Web Gwelliannau Gwasanaethau (WSE)

1. Golygu'r Web.config file canys web gwasanaethau. Y lleoliad diofyn yw:
   APICP Web GwasanaethauWeb.config
2. Dewch o hyd i'r tri achos o'r llinell sylwadau ganlynol:
   <!- ​​Diystyrwch yr elfen ganlynol os ydych yn defnyddio Web API Gwelliannau Gwasanaeth (WSE). Gadewch sylwadau os ydych chi'n defnyddio gwasanaethau WCF a ddim yn gosod Web Gwelliannau Gwasanaeth (WSE) –>
3. Diystyrwch yr elfen sy'n dilyn pob enghraifft o'r llinell sylwadau:
   <section name=”microsoft.web.gwasanaethau2″ … >webGwasanaethau >web.gwasanaethau2>
   Nodyn: Mae'rwebGwasanaethau > elfen i fod heb sylw yn blentyn oweb>.

Ffurfweddu logio ar gyfer y Web API Gwasanaethau
Rhaid i chi osod y log file lefelau llwybr a boncyff. Mae'r lefelau log yn gronnol. Am gynample, os byddwch yn nodi lefel 3, yna caiff lefelau 1, 2, a 3 eu cofnodi. Y lefel log ddiofyn yw 8.

1. Golygu'r web gwasanaethau Web.config. Y lleoliad diofyn yw:
   APICP Web GwasanaethauWeb.config
2. Gosodwch y LogFileLlwybr. Y gwerth rhagosodedig yw APIAPILlogs. 3. Gosodwch y LogLevel. Y gwerthoedd dilys yw:
   0 = Dim logio
   1 = Ffynhonnell gwrthrych a dull
   2 = Neges gwall
   3 = Paramedrau mewnbwn
   4 = Dychwelyd
   5 = Rhybudd
   8 = Checkpoint

Ffurfweddu dilysiad cyfeiriadur rhithwir ar gyfer y Web API Gwasanaethau
Rhaid i chi alluogi mynediad dienw ac analluogi dilysu Windows Integredig ar gyfer y CPWebCyfeiriadur rhithwir gwasanaeth yn y Gwasanaethau Gwybodaeth Rhyngrwyd (IIS). Am ragor o wybodaeth, gweler dogfennaeth Microsoft IIS.
Ffurfweddu gosodiadau cysylltiad cronfa ddata ar gyfer y Web API Gwasanaethau
Defnyddiwch y cyfleustodau Gosodiadau Mewngofnodi i amgryptio gosodiadau cysylltiad y gronfa ddata yn y Web API Gwasanaethau Web.config file. Am ragor o wybodaeth, chwiliwch am “Ffurfweddu Gosodiadau Cysylltiad Cronfa Ddata” yn y Canllaw Gosod Changepoint.
Ffurfweddu dilysu ar gyfer Changepoint WCF Web Gwasanaethau
Gallwch chi ffurfweddu Dilysu Cymhwysiad a mewngofnodi sengl (SSO) ar gyfer WCF Changepoint Web Gwasanaethau.
Mae'r opsiynau gweithredu canlynol ar gael gan ddefnyddio Secure Token Service (STS):

• SSO gan ddefnyddio ISAPI SSL dewisol
• SSO gan ddefnyddio WS-Federation (ADFS 2.0) SSL gofynnol

Os oes angen SSL, mae'r sgript ffurfweddu yn sicrhau ei fod yn cael ei ddefnyddio.
Gall y sgriptiau cyfluniad ar gyfer ISAPI a dilysu cymhwysiad alluogi SSL yn ddewisol.
Ffurfweddu dilysu cymhwysiad ar gyfer WCF Web Gwasanaethau
Y math dilysu rhagosodedig ar gyfer Changepoint WCF Web Dilysu cymhwysiad yw gwasanaethau.
Defnyddiwch y gweithdrefnau yn yr adran hon i:

• ffurfweddu Changepoint WCF Web Gwasanaethau i ddefnyddio dilysu cymhwysiad gyda SSL
• dychwelyd Changepoint WCF Web Gwasanaethau i ddilysu cymwysiadau ar ôl gweithredu un o'r gweithrediadau SSO

Ffurfweddu PowerShell

1. Agorwch anogwr Windows PowerShell.
2. Addasu'r polisi gweithredu:
   Set-CyflawniPolisi Anghyfyngedig

Stage 1 Casglu paramedrau cyfluniad
Darganfyddwch y gwerthoedd ar gyfer y paramedrau cyfluniad.

Paramedr	Disgrifiad
WebGwasanaeth_Llwybr	Lleoliad y WCF Changepoint Web Gwasanaethau web cais files. Rhagosodedig: \API\CP Web Gwasanaethau
Tystysgrif Gwasanaeth_ Enw	Enw tystysgrif a ddefnyddir i ddilysu'r gwasanaeth i gleientiaid gan ddefnyddio modd diogelwch Neges. Diofyn: Enw'r Dystysgrif “CN=Tystysgrif ChangepointAPIC”.
angen HTTPS	Angen HTTPS (Gwir / Gau) Diofyn: Gau.

Stage 2 Gweithredu sgriptiau ffurfweddu
Defnyddiwch y gwerthoedd ar gyfer y paramedrau cyfluniad i addasu ffurfweddiad y websafleoedd.

1.  Agorwch anogwr PowerShell.
   Nodyn: Os yw eich gweinydd wedi galluogi Rheoli Cyfrif Defnyddiwr, rhaid i chi agor yr anogwr PowerShell gan ddefnyddio caniatâd gweinyddwr uchel.
2. Llywiwch i'r CP web cyfeiriadur cyfluniad gwasanaeth, rhagosodedig:
   ConfigurationCPWebGwasanaeth
3.  Execute ./Configuration_AppAuth.ps1
4. Dilynwch yr awgrymiadau.

Ffurfweddu mewngofnodi sengl (SSO) ar gyfer WCF Web Gwasanaethau
Ffurfweddu PowerShell

1. Agorwch anogwr Windows PowerShell.
2. Addasu'r polisi gweithredu:
   Set-CyflawniPolisi Anghyfyngedig

Ffurfweddu SSO gan ddefnyddio ISAPI ar gyfer WCF Web Gwasanaethau
Stage 1 Casglu paramedrau cyfluniad
Darganfyddwch y gwerthoedd ar gyfer y paramedrau cyfluniad canlynol.

Paramedr	Disgrifiad
WebGwasanaeth_Llwybr	Lleoliad WCF Changepoint Web Gwasanaethau web cais files. Rhagosodedig: \API\CP Web Gwasanaethau
angen HTTPS	Angen HTTPS (Gwir / Gau). Diofyn: Gau.
Newidpoint_RSA_ Cwci_Trawsnewid	Enw'r dystysgrif rydych chi'n ei defnyddio ar gyfer amgryptio Cwcis. Diofyn: Enw'r Dystysgrif “CN=Tystysgrif ChangepointAPIC”.
GwasanaethTystysgrif_Enw	Rhowch enw'r dystysgrif a ddefnyddir i ddilysu'r gwasanaeth i gleientiaid gan ddefnyddio modd diogelwch Neges. Diofyn: Enw'r Dystysgrif “CN=Tystysgrif ChangepointAPIC”.
Tystysgrif_Enw Arwyddo	Rhowch enw'r dystysgrif arwyddo. Dyma enw'r dystysgrif rydych chi'n ei defnyddio ar gyfer llofnodi negeseuon. Diofyn: Enw'r Dystysgrif “CN=Tystysgrif ChangepointAPIC”.
ISAPI_Modd	Y modd ISAPI. Diofyn: NT
ISAPI_Pennawd	Y pennawd a ddefnyddir pan ISAPI_Mode yw “HEADER”, ar gyfer example, gwag.
Math o Hawliad	Rhowch y Math o Hawliad SSO. Rhagosodedig: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Gweithredu sgriptiau ffurfweddu

1. Agorwch anogwr PowerShell.
   Nodyn: Os yw eich gweinydd wedi galluogi Rheoli Cyfrif Defnyddiwr, rhaid i chi agor yr anogwr PowerShell gan ddefnyddio caniatâd gweinyddwr uchel.
2. Llywiwch i'r CP web cyfeiriadur cyfluniad gwasanaeth, rhagosodedig:
   ConfigurationCPWebGwasanaeth
3. Cyflawni: ./Configuration_SSO_ISAPI.ps1
4. Dilynwch yr awgrymiadau.

Ffurfweddu SSO gan ddefnyddio WS-Federation (ADFS 2.0) ar gyfer WCF Web Gwasanaethau
Stage 1 Casglu paramedrau cyfluniad
Darganfyddwch y gwerthoedd ar gyfer y paramedrau cyfluniad yn y tabl, isod. Sicrhewch fod yr ADFS_Server_URI ym mharth Mewnrwyd porwr y defnyddiwr terfynol.
Nodyn: Yn ddiofyn, mae Changepoint wedi'i ffurfweddu i ddiweddaru'n awtomatig yr allweddi cyhoeddus a ddefnyddir i lofnodi tocynnau diogelwch trwy ddefnyddio dogfen fetadata'r ffederasiwn a gyhoeddwyd. Yn ADFS dyma yw:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Mewn rhai achosion efallai na fydd yn bosibl cyrraedd y gweinydd ADFS o'r Changepoint web gweinydd felly bydd yn rhaid i chi ddiweddaru'r ffurfweddiad â llaw ar ôl rhedeg y sgript ffurfweddu. Am fanylion, gweler “Diweddaru allweddi cyhoeddus â llaw” ar dudalen 12.

Paramedr	Disgrifiad
WebGwasanaeth_Llwybr	Lleoliad y WCF Changepoint Web Gwasanaethau web cais files. Rhagosodedig: \API\CP Web Gwasanaethau
WebGwasanaeth_URI	Dynodwr parth a ddefnyddiwch ar gyfer Changepoint WCF Web Gwasanaethau. Am gynample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Enw'r dystysgrif rydych chi'n ei defnyddio ar gyfer amgryptio Cwcis. Diofyn: Enw'r Dystysgrif “CN=ChangepointApiCertificate”.
GwasanaethTystysgrif_Enw	Enw tystysgrif a ddefnyddir i ddilysu'r gwasanaeth i gleientiaid gan ddefnyddio modd diogelwch Neges. Diofyn: Enw'r Dystysgrif “CN=ChangepointApiCertificate”.
Tystysgrif_Enw Arwyddo	Enw'r dystysgrif rydych chi'n ei defnyddio ar gyfer llofnodi negeseuon. Diofyn: defnyddir yr Enw Tystysgrif “CN=ChangepointApiCertificate”.
ADFS_ FederationServiceName	Enw Gwasanaeth Ffederasiwn. I gael yr enw: O'r gweinydd ADFS, Lansio consol ADFS 2.0 Management. •Dewiswch ADFS 2.0 o'r ddewislen chwith. •O'r panel Gweithredu dewiswch Golygu Priodweddau Gwasanaeth Ffederasiwn. Mae Enw Gwasanaeth y Ffederasiwn ar y tab Cyffredinol.
Math o Hawliad	SSO Math o Hawl. Y rhagosodiad yw: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Gweithredu sgriptiau ffurfweddu
Ffurfweddu'r websafleoedd sy'n defnyddio'r gwerthoedd ar gyfer y paramedrau cyfluniad.

1. Agorwch anogwr PowerShell.
   Nodyn: Os yw eich gweinydd wedi galluogi Rheoli Cyfrif Defnyddiwr, rhaid i chi agor yr anogwr PowerShell gan ddefnyddio caniatâd gweinyddwr uchel.
2. Llywiwch i'r Changepoint web cyfeiriadur cyfluniad gwasanaeth, rhagosodedig: ConfigurationCPWebGwasanaeth
3.  Cyflawni: ./Configuration_SSO_ADFS.ps1
4. Dilynwch yr awgrymiadau.

Stage 3 Creu ymddiriedaeth plaid ddibynnol
Creu'r Relying Party Trust yn ADFS 2.0 Consol.

1. Ar eich gweinydd ADFS, lansiwch y consol ADFS 2.0.
2. Dewiswch Gweithredu > Ychwanegu Ymddiriedolaeth Parti Dibynnol.
3. Cliciwch Cychwyn.
4. Dewiswch Mewnforio data am y parti sy'n dibynnu a gyhoeddwyd ar-lein neu ar rwydwaith lleol.
5. Rhowch gyfeiriad metadata'r Ffederasiwn, ac yna cliciwch ar Next, ar gyfer example:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Rhowch enw Arddangos, ee API Changepoint WCF, a chliciwch ar Next, Next, Next, yna Close.
7. Ychwanegu Rheol Hawlio ar gyfer y Blaid Ddibynnol Changepoint uchod. Ar gyfer Changepoint, yr enw rheol Hawliad rhagosodedig yw “UPN”.
8. Mapiwch y Priodoledd LDAP “Enw-Prif Ddefnyddiwr” i'r Math o Hawliad sy'n Mynd Allan “* UPN” neu “UPN”.

Diweddaru allweddi cyhoeddus â llaw
I gael Bawdbrint Llofnodi Tocyn Gweinydd ADFS

1. O'r gweinydd ADFS, Lansio consol ADFS 2.0 Management.
2. Dewiswch Gwasanaeth > Tystysgrifau, a chliciwch ddwywaith ar y dystysgrif arwyddo Tocyn.
3. Dewiswch y tab Manylion.
4. Dewiswch y maes Bawdlun.
5. I gael y gwerth bawd, tynnwch yr holl fylchau gan gynnwys y gofod cyntaf.

I ddiweddaru'r Web.config file

1. Golygu'r ADFS web.config. Y lleoliad diofyn yw:
   EnterpriseRP-STS_ADFS
2. O dan y elfen, darganfyddwch yr allwedd ida:FederationMetadataLocation a chliriwch ei werth:
   
3. Dan , dod o hyd i'r elfen a rhoi'r canlynol yn ei le: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust" />

Profi'r cysylltiad COM API

1. Rhedeg y Pecyn Prawf API. Y lleoliad diofyn yw:
   APIAPI ComponentsApiTestKit.exe.
2. Cliciwch Llinyn Cysylltiad > Amgryptio.
3. Yn y maes Llinyn Cysylltiadau Testun Plaen:
   a. Disodli SERVERNAME a DATABASENAME gyda'ch gwybodaeth cronfa ddata.
   b. Disodli USERID a PASSWORD gyda'ch cronfa ddata gweinyddwr gwybodaeth cyfrif defnyddiwr.
   c. Rhowch y gwerth terfyn amser yn ôl yr angen.
4. Cliciwch Amgryptio.
5. Yn y maes Llinyn Cysylltiad Amgryptio, copïwch y testun.
6. Caewch y blwch deialog.
7. Ar y ddewislen API Test Kit, cliciwch Connection > COM API Connection Tester.
8. Yn y tab Fersiwn Cyfredol, gludwch y llinyn cysylltiad wedi'i amgryptio i'r maes Llinyn Cysylltiad.
9. Yn y meysydd LoginId a Chyfrinair, nodwch yr ID mewngofnodi a'r cyfrinair ar gyfer eich cyfrif Changepoint.
10. Yn y maes Loglevel (0-8), nodwch lefel y wybodaeth gwall i'w dychwelyd yn y log API COM file os yw canlyniad y prawf yn dangos problem gyda'r cysylltiad.
    0 = Dim logio
    1 = Ffynhonnell gwrthrych a dull
    2 = Neges gwall
    3 = Paramedrau mewnbwn
    4 = Dychwelyd
    5 = Rhybudd
    8 = Checkpoint
    Y rhagosodiad yw 8.
11. Cliciwch Connect.
    Os bu'r cysylltiad yn llwyddiannus, dangosir neges llwyddiant yn y maes Canlyniad. Os methodd y cysylltiad, gwiriwch y log API COM file am wallau. Lleoliad rhagosodedig y log file yn APIAPILlogs.

Gwirio'r fersiwn o gydrannau API sydd wedi'u gosod
Gallwch ddefnyddio'r cyfleustodau gwirio fersiwn i gael manylion am y cydrannau gosod, gan gynnwys y fersiwn rhyddhau a llwybr.

1. Rhedeg CPVersionChecker.exe. Y llwybr rhagosodedig yw: Cydrannau APIAPI
2. Cliciwch Darllen.

Wrth wirio fersiwn y Web API Gwasanaethau

1. Lansio Internet Explorer o'r gweinydd lle mae'r Web Mae API Gwasanaethau wedi'i osod, a rhowch y cyfeiriad:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  lle porthladd yw rhif porthladd y websafle lle gosodoch y CPWebCyfeiriadur rhithwir gwasanaeth.
2. Ar dudalen WSLogin, cliciwch ar y ddolen GetVersion.
3. Cliciwch Invoke.

Profi y Web Cysylltiad API gwasanaethau

1. Lansio Internet Explorer o'r gweinydd lle mae'r Web Mae API Gwasanaethau wedi'i osod, a rhowch y cyfeiriad: http://localhost.port/CPWeb.Service/WSLogin.asmx  lle porthladd yw rhif porthladd y websafle lle gosodoch y CPWebCyfeiriadur rhithwir gwasanaeth.
2. Ar dudalen WSLogin cliciwch ar y ddolen TestConnection.
3. Cliciwch Invoke. 4. Yn y canlyniadau prawf:

• Os elfen yn ffug, llwyddodd y cysylltiad prawf.
• Os elfen yn wir, methodd y cysylltiad prawf. Am fwy
  gwybodaeth am y rhesymau dros y methiant, gweler y a elfennau yn y canlyniadau prawf, a gwiriwch y logiau API. Y llwybr rhagosodedig i'r logiau API yw: APIAPILlogs

Sefydlu'r Web API Gwasanaethau ar weinydd iaith

1. I ddefnyddio'r Changepoint Web API Gwasanaethau ar weinydd iaith, rhaid i chi ychwanegu neu ddiweddaru'r tag yn y Web API Gwasanaethau web.config. Mae lleoliad diofyn y Web.config file yw: APICP Web GwasanaethauWeb.config
2. Os bydd y tag eisoes yn bodoli, sicrhau bod nodweddion diwylliant a uiCulture yn “en-UD.”
3. Os bydd y tag ddim yn bodoli eisoes, ychwanegwch y canlynol , sylwad, a elfennau i'rweb> nod:web>
   Opsiynau Visual Basic: Gosodwch llym = ”gwir” i wrthod pob math o drawsnewidiad data lle gall colli data ddigwydd. Gosod yn eglur = “gwir” i orfodi datganiad o'r holl newidynnau. ->
4. Ailgychwyn IIS.

Dogfennau / Adnoddau

Meddalwedd API Changepoint [pdfCanllaw Gosod API, Meddalwedd, Meddalwedd API

Cyfeiriadau

• Llawlyfr Defnyddiwr