Treoir Suiteáil Bogearraí Changepoint API

Treoir Suiteála API
Treoir Thagartha
Athrúphointe 2021

© 2021 Changepoint Canada ULC Gach ceart ar cosaint. CEARTA RIALTAIS SAM - Tá úsáid, dúbailt, nó nochtadh ag Rialtas SAM faoi réir srianta mar atá leagtha amach i gcomhaontú ceadúnais Changepoint Canada ULC agus mar a fhoráiltear in DFARS 227.7202-1(a) agus 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, nó FAR 52.227-14 (ALT III), de réir mar is infheidhme. Tá faisnéis rúnda agus rúin trádála Changepoint Canada ULC sa táirge seo. Tá cosc ​​ar nochtadh gan cead sainráite i scríbhinn a fháil roimh ré ó Changepoint Canada ULC. Tá úsáid an táirge seo faoi réir théarmaí agus choinníollacha Chomhaontú Ceadúnais an úsáideora le Changepoint Canada ULC. Ní féidir leis an gCeadúnaí doiciméadú a atáirgeadh ach le haghaidh úsáide inmheánach. Ní féidir ábhar an doiciméid seo a athrú, a mhodhnú nó a athrú gan toiliú sainráite i scríbhinn ó Changepoint Canada ULC. Féadfaidh Changepoint Canada ULC an t-ábhar atá sonraithe anseo a athrú am ar bith, le fógra nó gan fógra.

Suiteáil an API Changepoint

Maidir leis an API Changepoint a shuiteáil
Tá an API Changepoint ar fáil mar API COM, seirbhís de chuid Windows Communication Foundation (WCF) agus, le haghaidh comhoiriúnachta siar, mar Web Seirbhís Feabhsuithe ar Sheirbhísí (MSU). Chun faisnéis a fháil faoin API Changepoint, féach an Tagairt API Changepoint. Le haghaidh nótaí uasghrádaithe, caveatanna agus saincheisteanna aitheanta, féach ar na Nótaí Eisiúna i bhfillteáin foirne in Changepoint.
Tá an API Changepoint á uasghrádú
Má tá tú ag uasghrádú ó eisiúint roimhe seo de Changepoint, bain úsáid as Painéal Rialúcháin Windows chun an leagan roimhe seo den API Changepoint agus a chomhpháirteanna a dhíshuiteáil roimh an leagan seo a shuiteáil.
Riachtanais API Changepoint
Ní mór duit Changepoint a shuiteáil sula suiteálann tú an API Changepoint. Le haghaidh riachtanais bogearraí, féach an Maitrís Comhoiriúnachta Bogearraí Changepoint, atá ar fáil i bhfillteán foirne Nótaí Eisiúna agus Paistí 2021 in Changepoint.
File gnásanna cosáin
Ar fud an doiciméid seo, úsáidtear na coinbhinsiúin seo a leanas le haghaidh cosáin choiteanna:

• Conair fhréamh na suiteála Changepoint.
  Is é an cosán réamhshocraithe:
  C: Clár Files (x86)ChangepointChangepoint
• An suíomh fréimhe le haghaidh fóntais choiteanna Changepoint, mar an áirgiúlacht Socruithe Logála isteach.
  Is é an cosán réamhshocraithe:
  C: Clár Files (x86) Coiteann FilesChangepointChangepoint

Suiteáil an API Changepoint

1. Ón eolaire fréamhacha meáin Changepoint API, rith setup.exe.
2. Lean na leideanna go dtí go bhfeicfear an scáileán Roghnaigh Gnéithe.
3. Roghnaigh na gnéithe is mian leat a shuiteáil, ansin cliceáil Ar Aghaidh.
4. Roghnaigh an fillteán scríbe API, réamhshocraithe API, agus cliceáil Ar Aghaidh.
   Nóta: Tá an fóntais Changepoint Login Settings suiteáilte i LoginSettings, beag beann ar an bhfillteán sprice a shonróidh tú.
5. Má roghnaigh tú an Web API Seirbhísí: a. Nuair a bheidh an Roghnaigh
   a Web Tá an chuma ar an scáileán suímh, roghnaigh a websuíomh chun an t-eolaire fíorúil a chur leis, agus ansin cliceáil Ar Aghaidh.
   b. Cliceáil Ar Aghaidh chun leanúint ar aghaidh. 6. Nuair a bheidh suiteáil an API críochnaithe, cliceáil Críochnaigh.

Cumrú an API Changepoint le bheith feasach ar an taisce
Chun an API Changepoint a chumrú le bheith feasach ar an taisce, cuir na luachanna don “taisce. Pasfhocal” agus “taisce. Freastalaithe” eochracha sa CP Web SeirbhísíWeb.config file leis na luachanna a úsáidtear san FhiontraíochtWeb.config file.
Á chumasú Web Feabhsuithe ar Sheirbhísí (MSU)

1. Cuir an Web.config file le haghaidh web seirbhísí. Is é an suíomh réamhshocraithe:
   APICP Web SeirbhísíWeb.config
2. Faigh na trí chás den líne tráchta seo a leanas:
   <!– Déan trácht ar an eilimint seo a leanas má tá tú ag úsáid Web API Feabhsuithe Seirbhíse (WSE). Fág trácht má tá seirbhísí WCF á n-úsáid agat agus mura bhfuil siad á shuiteáil Web Feabhsuithe Seirbhíse (MSU) –>
3. Déan trácht ar an eilimint a leanann gach cás den líne tráchtaireachta:
   <ainm alt =” microsoft.web.seirbhísí2″ … >webSeirbhísí >web.seirbhísí2>
   Nóta: Tá anwebIs leanbh de chuid seirbhísí > eilimint le bheith gan tráchtweb>.

Chun logáil a chumrú don Web API Seirbhísí
Ní mór duit an logáil a shocrú file leibhéil cosáin agus loga. Tá na leibhéil loga carnach. Le haghaidh example, má shonraíonn tú leibhéal 3, ansin déantar leibhéil 1, 2, agus 3 a logáil. Is é 8 an leibhéal logála réamhshocraithe.

1. Cuir an web seirbhísí Web.config. Is é an suíomh réamhshocraithe:
   APICP Web SeirbhísíWeb.config
2. Socraigh an LogFileConair. Is é an luach réamhshocraithe APIAPILlogs. 3. Socraigh an LogLevel. Is iad na luachanna bailí:
   0 = Gan logáil
   1 = Foinse réad agus modh
   2 = Teachtaireacht earráide
   3 = paraiméadair ionchuir
   4 = Filleann
   5 = Rabhadh
   8 = Seicphointe

Comhadlann fíordheimhnithe a chumrú don Web API Seirbhísí
Ní mór duit rochtain gan ainm a chumasú agus fíordheimhniú Comhtháite Windows a dhíchumasú don CPWebEolaire fíorúil seirbhíse i Seirbhísí Faisnéise Idirlín (IIS). Le haghaidh tuilleadh faisnéise, féach doiciméadú Microsoft IIS.
Socruithe nasc bunachar sonraí a chumrú don Web API Seirbhísí
Bain úsáid as an áirgiúlacht Socruithe Logála isteach chun na socruithe nasc bunachar sonraí a chriptiú sa Web API Seirbhísí Web.config file. Chun tuilleadh faisnéise a fháil, déan cuardach do “Socruithe Nasc Bunachar Sonraí a Chumrú” sa Treoir Suiteála Changepoint.
Fíordheimhniú a chumrú do WCF Changepoint Web Seirbhísí
Is féidir leat Fíordheimhniú Feidhmchláir agus síniú aonair (SSO) a chumrú le haghaidh WCF Changepoint Web Seirbhísí.
Tá na roghanna cur chun feidhme seo a leanas ar fáil trí úsáid a bhaint as Secure Token Service (STS):

• SSO ag baint úsáide as ISAPI SSL roghnach
• SSO ag baint úsáide as WS-Chónaidhm (ADFS 2.0) SSL ag teastáil

Má tá SSL ag teastáil, cinntíonn an script cumraíochta go n-úsáidtear é.
Is féidir leis na scripteanna cumraíochta le haghaidh ISAPI agus fíordheimhniú feidhmchlár SSL a chumasú go roghnach.
Fíordheimhniú feidhmchláir a chumrú le haghaidh WCF Web Seirbhísí
An cineál fíordheimhnithe réamhshocraithe do Changepoint WCF Web Is fíordheimhniú feidhmchlár iad seirbhísí.
Bain úsáid as na nósanna imeachta sa chuid seo chun:

• chumraigh Changepoint WCF Web Seirbhísí chun fíordheimhniú feidhmchláir a úsáid le SSL
• aisiompú Changepoint WCF Web Seirbhísí fíordheimhnithe feidhmchláir tar éis ceann de na feidhmeanna SSO a chur i bhfeidhm

Cumraigh PowerShell

1. Oscail leid Windows PowerShell.
2. Athraigh an polasaí forghníomhaithe:
   Set-ExecutionPolicy Neamhshrianta

Stage 1 Bailigh paraiméadair chumraíochta
Socraigh na luachanna do na paraiméadair chumraíochta.

Paraiméadar	Cur síos
WebSeirbhís_Conair	Suíomh an WCF Changepoint Web Seirbhísí web iarratas files. Réamhshocrú: \API\CP Web Seirbhísí
Teastas Seirbhíse_ Ainm	Ainm an teastais a úsáidfear chun an tseirbhís do chliaint a fhíordheimhniú ag baint úsáide as modh slándála Teachtaireacht. Réamhshocrú: Ainm an Teastais “CN=Teastas ChangepointAPIC”.
HTTPS a cheangal	Teastaíonn HTTPS (Fíor/Bréagach) Réamhshocrú: Bréagach.

Stage 2 Rith scripteanna cumraíochta
Úsáid na luachanna do na paraiméadair chumraíochta chun cumraíocht an webláithreáin.

1.  Oscail leid PowerShell.
   Nóta: Má tá Rialú Cuntas Úsáideora cumasaithe ag do fhreastalaí, ní mór duit an leid PowerShell a oscailt ag baint úsáide as ceadanna ardaithe riarthóra.
2. Déan nascleanúint chuig an CP web eolaire cumraíochta seirbhíse, réamhshocraithe:
   CumraíochtCPWebSeirbhís
3.  Rith ./Configuration_AppAuth.ps1
4. Lean na leideanna.

Comhartha aonair (SSO) a chumrú do WCF Web Seirbhísí
Cumraigh PowerShell

1. Oscail leid Windows PowerShell.
2. Athraigh an polasaí forghníomhaithe:
   Set-ExecutionPolicy Neamhshrianta

SSO a chumrú le ISAPI do WCF Web Seirbhísí
Stage 1 Bailigh paraiméadair chumraíochta
Aimsigh na luachanna do na paraiméadair chumraíochta seo a leanas.

Paraiméadar	Cur síos
WebSeirbhís_Conair	Suíomh an WCF Changepoint Web Seirbhísí web iarratas files. Réamhshocrú: \API\CP Web Seirbhísí
HTTPS a cheangal	HTTPS (Fíor/Bréagach) a éileamh. Réamhshocrú: Bréagach.
Athrúphointe_RSA_ Fianán_Claochlú	Ainm an teastais a úsáideann tú le haghaidh criptithe Fianán. Réamhshocrú: Ainm an Teastais “CN=Teastas ChangepointAPIC”.
ServiceCertificate_Name	Cuir isteach ainm an teastais a úsáidfear chun an tseirbhís do chliaint a fhíordheimhniú ag baint úsáide as modh slándála Teachtaireacht. Réamhshocrú: Ainm an Teastais “CN=Teastas ChangepointAPIC”.
Síniú Teastas_Ainm	Cuir isteach ainm an teastais sínithe. Seo é ainm an teastais a úsáideann tú chun teachtaireachtaí a shíniú. Réamhshocrú: Ainm an Teastais “CN=Teastas ChangepointAPIC”.
ISAPI_Mód	An mód ISAPI. Réamhshocrú: NT
ISAPI_Ceanntásc	Is é an ceanntásc a úsáidtear nuair a bhíonn ISAPI_Mode ná “HEADER”, le haghaidh example, bán.
Cineál Éilimh	Cuir isteach an Cineál Éilimh SSO. Réamhshocrú: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Rith scripteanna cumraíochta

1. Oscail leid PowerShell.
   Nóta: Má tá Rialú Cuntas Úsáideora cumasaithe ag do fhreastalaí, ní mór duit an leid PowerShell a oscailt ag baint úsáide as ceadanna ardaithe riarthóra.
2. Déan nascleanúint chuig an CP web eolaire cumraíochta seirbhíse, réamhshocraithe:
   CumraíochtCPWebSeirbhís
3. Rith: ./Configuration_SSO_ISAPI.ps1
4. Lean na leideanna.

SSO a chumrú ag baint úsáide as WS-Feederation (ADFS 2.0) le haghaidh WCF Web Seirbhísí
Stage 1 Bailigh paraiméadair chumraíochta
Aimsigh na luachanna do na paraiméadair chumraíochta sa tábla, thíos. Cinntigh go bhfuil an ADFS_Server_URI i gcrios Inlín de bhrabhsálaí an úsáideora deiridh.
Nóta: De réir réamhshocraithe, tá Changepoint cumraithe chun na heochracha poiblí a úsáidtear chun comharthaí slándála a shíniú a nuashonrú go huathoibríoch trí úsáid a bhaint as doiciméad meiteashonraí na Cónaidhme foilsithe. In ADFS is é seo:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
I gcásanna áirithe b’fhéidir nach mbeifear in ann an freastalaí ADFS a bhaint amach ón Changepoint web freastalaí ionas go mbeidh ort an chumraíocht a nuashonrú de láimh tar éis duit an script cumraíochta a rith. Le haghaidh sonraí, féach “Eochracha poiblí a nuashonrú de láimh” ar leathanach 12.

Paraiméadar	Cur síos
WebSeirbhís_Conair	Suíomh an WCF Changepoint Web Seirbhísí web iarratas files. Réamhshocrú: \API\CP Web Seirbhísí
WebSeirbhís_URI	Aitheantóir fearainn a úsáideann tú do Changepoint WCF Web Seirbhísí. Le haghaidh example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Ainm an teastais a úsáideann tú le haghaidh criptithe Fianán. Réamhshocrú: Ainm an Teastais “CN=ChangepointApiCertificate”.
ServiceCertificate_Name	Ainm an teastais a úsáidfear chun an tseirbhís do chliaint a fhíordheimhniú ag baint úsáide as modh slándála Teachtaireacht. Réamhshocrú: Ainm an Teastais “CN=ChangepointApiCertificate”.
Síniú Teastas_Ainm	Ainm an teastais a úsáideann tú chun teachtaireachtaí a shíniú. Réamhshocrú: úsáidtear Ainm an Teastais “CN=ChangepointApiCertificate”.
ADFS_ FederationServiceName	Ainm Seirbhíse Cónaidhme. Chun an t-ainm a fháil: Ó fhreastalaí ADFS, Seoladh consól Bainistíochta ADFS 2.0. • Roghnaigh ADFS 2.0 ón roghchlár ar chlé. • Ón bpána Gníomhaíochta roghnaigh Edit Federation Service Properties. Tá Ainm na Seirbhíse Cónaidhme ar an táb Ginearálta.
Cineál Éilimh	Cineál Éilimh SSO. Is é an réamhshocrú: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Rith scripteanna cumraíochta
Cumraigh an webláithreáin ag baint úsáide as na luachanna do na paraiméadair chumraíochta.

1. Oscail leid PowerShell.
   Nóta: Má tá Rialú Cuntas Úsáideora cumasaithe ag do fhreastalaí, ní mór duit an leid PowerShell a oscailt ag baint úsáide as ceadanna ardaithe riarthóra.
2. Déan nascleanúint chuig an Changepoint web eolaire cumraíochta seirbhíse, réamhshocraithe: CumraíochtCPWebSeirbhís
3.  Rith: ./Configuration_SSO_ADFS.ps1
4. Lean na leideanna.

Stage 3 Cruthaigh muinín páirtí spleách
Cruthaigh an Iontaobhas Páirtí ag brath i ADFS 2.0 Console.

1. Ar do fhreastalaí ADFS, seol an consól ADFS 2.0.
2. Roghnaigh Gníomh > Cuir Iontaobhas Páirtí ag brath leis.
3. Cliceáil Tosaigh.
4. Roghnaigh Iompórtáil sonraí faoin bpáirtí ag brath arna bhfoilsiú ar líne nó ar líonra áitiúil.
5. Cuir isteach seoladh meiteashonraí na Cónaidhme, agus ansin cliceáil Ar Aghaidh, le haghaidh example:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Cuir isteach ainm Taispeána, m.sh. Changepoint WCF API, agus cliceáil Ar Aghaidh, Ar Aghaidh, Ar Aghaidh, ansin Dún.
7. Cuir Riail Éilimh leis don Pháirtí atá ag brath ar Changepoint thuas. Maidir le Changepoint, is é an t-ainm riail réamhshocraithe Éilimh ná “UPN”.
8. Mapáil Tréith an LDAP “Príomh-Ainm Úsáideora” do Chineál Éilimh Amach “* UPN” nó “UPN”.

Eochracha poiblí a nuashonrú de láimh
Chun Mionphrionta Comharthaíochta Chomhartha Freastalaí ADFS a fháil

1. Ó fhreastalaí ADFS, Seoladh consól Bainistíochta ADFS 2.0.
2. Roghnaigh Seirbhís > Deimhnithe, agus cliceáil faoi dhó ar an teastas sínithe Chomhartha.
3. Roghnaigh an cluaisín Sonraí.
4. Roghnaigh an réimse Thumbprint.
5. Chun luach an ordóg a fháil, bain na spásanna go léir lena n-áirítear an chéad spás.

Chun nuashonrú a dhéanamh ar an Web.config file

1. Cuir an ADFS in eagar web.config. Is é an suíomh réamhshocraithe:
   EnterpriseRP-STS_ADFS
2. Faoin eilimint, faigh an eochair ida:FederationMetadataLocation agus soiléir a luach:
   
3. Faoi , faigh an eilimint agus cuir an méid seo a leanas ina ionad: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust" />

An nasc COM API á thástáil

1. Rith an Kit Tástála API. Is é an suíomh réamhshocraithe:
   Comhpháirteanna APIAPIApiTestKit.exe.
2. Cliceáil Teaghrán Ceangail > Criptitheoir.
3. Sa réimse Teaghrán Ceangal Téacs Gnáth:
   a. Ionadaigh SERVERNAME agus DATABASENAME le faisnéis do bhunachar sonraí.
   b. Cuir do bhunachar sonraí cuntas úsáideora admin in ionad USERID agus PASSWORD.
   c. Cuir isteach an luach am istigh de réir mar is gá.
4. Cliceáil Criptigh.
5. Sa réimse Teaghrán Ceangail Criptithe, cóipeáil an téacs.
6. Dún an bosca dialóige.
7. Ar an roghchlár API Test Kit, cliceáil Ceangal > COM API Connection Tester.
8. Sa chluaisín Leagan Reatha, greamaigh an teaghrán nasc criptithe isteach sa réimse Teaghrán Ceangail.
9. Sna réimsí LoginId agus Pasfhocal, cuir isteach an ID logáil isteach agus do phasfhocal do do chuntas Changepoint.
10. Sa réimse Loglevel (0-8), sonraigh an leibhéal faisnéise earráide atá le cur ar ais i loga COM API file má léiríonn toradh na tástála fadhb leis an gceangal.
    0 = Gan logáil
    1 = Foinse réad agus modh
    2 = Teachtaireacht earráide
    3 = paraiméadair ionchuir
    4 = Filleann
    5 = Rabhadh
    8 = Seicphointe
    Is é 8 an réamhshocrú.
11. Cliceáil Connect.
    Má d'éirigh leis an nasc, taispeántar teachtaireacht ratha sa réimse Toradh. Má theip ar an nasc, seiceáil an logáil COM API file le haghaidh earráidí. Suíomh réamhshocraithe an loga file tá APIAPILlogs.

Ag seiceáil leagan na gcomhpháirteanna API suiteáilte
Is féidir leat an fóntais seiceála leagan a úsáid chun sonraí a fháil faoi na comhpháirteanna suiteáilte, lena n-áirítear an leagan scaoilte agus an cosán.

1. Rith CPVersionChecker.exe. Is é an cosán réamhshocraithe: Comhpháirteanna APIAPI
2. Cliceáil Léigh.

Ag seiceáil leagan an Web API Seirbhísí

1. Seoladh Internet Explorer ón bhfreastalaí ina bhfuil an Web Tá API Seirbhísí suiteáilte, agus cuir isteach an seoladh:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  áit a bhfuil port uimhir phoirt an weban suíomh inar shuiteáil tú an CPWebEolaire fíorúil seirbhíse.
2. Ar an leathanach WSLogin, cliceáil ar an nasc GetVersion.
3. Cliceáil Invoke.

Ag tástáil an Web Nasc API seirbhísí

1. Seoladh Internet Explorer ón bhfreastalaí ina bhfuil an Web Tá API Seirbhísí suiteáilte, agus cuir isteach an seoladh: http://localhost.port/CPWeb.Service/WSLogin.asmx  áit a bhfuil port uimhir phoirt an weban suíomh inar shuiteáil tú an CPWebEolaire fíorúil seirbhíse.
2. Ar an leathanach WSLogin cliceáil ar an nasc TestConnection.
3. Cliceáil Invoke. 4. Sna torthaí tástála:

• Dá eilimint bréagach, d'éirigh leis an nasc tástála.
• Dá eilimint fíor, theip ar an nasc tástála. Chun níos mó
  eolas ar na cúiseanna atá leis an teip, féach ar an agus eilimintí sna torthaí tástála, agus seiceáil na logaí API. Is é an cosán réamhshocraithe chuig logaí API: APIAPILlogs

Socrú an Web API Seirbhísí ar fhreastalaí teanga

1. Chun an Changepoint a imscaradh Web Seirbhísí API ar fhreastalaí teanga, ní mór duit a chur leis nó a nuashonrú tag sna Web API Seirbhísí web.config. Suíomh réamhshocraithe an Web.config file tá: APICP Web SeirbhísíWeb.config
2. Má tá an tag cheana féin, cinntigh go bhfuil tréithe cultúir agus uiCulture araon “en-SAM.”
3. Má tá an tag nach bhfuil ann cheana, cuir an méid seo a leanas leis , trácht, agus gnéithe donweb> nód:web>
   Roghanna Amhairc Bunúsacha: Socraigh docht = “fíor” chun gach tiontú cineál sonraí a dhícheadú nuair is féidir sonraí a chailliúint. Socraigh sainráite = “fíor” chun dearbhú gach athróg a chur i bhfeidhm. –>
4. Atosaigh IIS.