Changepoint API Software fifi sori Itọsọna

API fifi sori Itọsọna
Itọsọna itọkasi
Iyipada 2021

© 2021 Changepoint Canada ULC Gbogbo ẹtọ wa ni ipamọ. Awọn ẹtọ ijọba AMẸRIKA-Lilo, ẹda-iwe, tabi ifihan nipasẹ Ijọba AMẸRIKA wa labẹ awọn ihamọ bi a ti ṣeto tẹlẹ ninu adehun iwe-aṣẹ Changepoint Canada ULC ati bi a ti pese ni DFARS 227.7202-1(a) ati 227.7202-3(a) (1995), DFARS 252.227-7013 (c) (1) (ii) (OCT 1988), FAR 12.212 (a) (1995), FAR 52.227-19, tabi FAR 52.227-14 (ALT III), bi iwulo. Ọja yii ni alaye asiri ati awọn aṣiri iṣowo ti Changepoint Canada ULC ninu. Ifihan ti ni idinamọ laisi igbanilaaye kikọ ti iṣaaju ti Changepoint Canada ULC. Lilo ọja yi jẹ koko ọrọ si awọn ofin ati ipo ti Adehun Iwe-aṣẹ olumulo pẹlu Changepoint Canada ULC. Iwe aṣẹ le jẹ tun ṣe nipasẹ Licensee fun lilo inu. Akoonu iwe yii le ma ṣe paarọ, tunṣe tabi yipada laisi ifọkansi kikọ kiakia ti Changepoint Canada ULC. Changepoint Canada ULC le yi akoonu ti o pato ninu rẹ pada nigbakugba, pẹlu tabi laisi akiyesi.

Fifi Changepoint API sori ẹrọ

Nipa fifi sori ẹrọ Changepoint API
API Changepoint wa bi COM API, iṣẹ Ibaraẹnisọrọ Ibaraẹnisọrọ Windows kan (WCF) ati, fun ibaramu sẹhin, bi Web Awọn iṣẹ Imudara Awọn iṣẹ (WSE). Fun alaye nipa Changepoint API, wo Itọkasi API Changepoint. Fun awọn akọsilẹ igbesoke, awọn akiyesi ati awọn ọran ti a mọ, wo Awọn akọsilẹ Tu silẹ ninu awọn folda ẹgbẹ ni Changepoint.
Igbegasoke API Changepoint
Ti o ba n ṣe igbesoke lati itusilẹ ti tẹlẹ ti Changepoint, lo Igbimọ Iṣakoso Windows lati mu ẹya iṣaaju ti Changepoint API kuro ati awọn paati rẹ ṣaaju fifi ẹya yii sori ẹrọ.
Changepoint API ibeere
O gbọdọ fi Changepoint sori ẹrọ ṣaaju ki o to fi Changepoint API sori ẹrọ. Fun awọn ibeere sọfitiwia, wo Matrix Ibamu Sọfitiwia Changepoint, eyiti o wa ninu Awọn akọsilẹ Itusilẹ 2021 ati folda ẹgbẹ awọn abulẹ ni Changepoint.
File awọn apejọ ọna
Ninu iwe-ipamọ yii, awọn apejọ atẹle wọnyi ni a lo fun awọn ọna ti o wọpọ:

• Awọn root ona ti awọn Changepoint fifi sori.
  Ọna aiyipada ni:
  C: Eto Files (x86)ChangepointChangepoint
• Ipo gbongbo fun awọn ohun elo Changepoint ti o wọpọ, gẹgẹbi IwUlO Eto Wọle.
  Ọna aiyipada ni:
  C: Eto Files (x86) Wọpọ FilesChangepointChangepoint

Fifi Changepoint API sori ẹrọ

1. Lati Changepoint API media root liana, ṣiṣe setup.exe.
2. Tẹle awọn ilana naa titi ti iboju Awọn ẹya ara ẹrọ Yan yoo han.
3. Yan awọn ẹya ti o fẹ fi sii, lẹhinna tẹ Itele.
4. Yan folda ibi ti API, aiyipada API, ki o si tẹ Itele.
   Akiyesi: IwUlO Eto Iwiwọle Changepoint ti fi sori ẹrọ ni Eto wiwọle, laibikita folda opin irin ajo ti o pato.
5. Ti o ba yan awọn Web API Services: a. Nigbati awọn Yan
   a Web Iboju ojula yoo han, yan a webojula lati fi awọn foju liana si, ati ki o si tẹ Itele.
   b. Tẹ Itele lati tẹsiwaju. 6. Nigbati fifi sori ẹrọ ti API ba ti pari, tẹ Pari.

Tito leto Changepoint API lati jẹ akiyesi kaṣe
Lati tunto API Changepoint lati jẹ akiyesi kaṣe, rọpo awọn iye fun “kaṣe. Ọrọigbaniwọle" ati "kaṣe. Awọn bọtini olupin ni CP Web Awọn iṣẹWeb.konfigi file pẹlu awọn iye lo ninu awọn IdawọlẹWeb.konfigi file.
Muu ṣiṣẹ Web Awọn ilọsiwaju iṣẹ (WSE)

1. Ṣatunkọ awọn Web.konfigi file fun web awọn iṣẹ. Ipo aiyipada ni:
   APICP Web Awọn iṣẹWeb.konfigi
2. Wa awọn iṣẹlẹ mẹta ti laini asọye atẹle:
   < ! – Uncomment awọn wọnyi ano ti o ba ti wa ni lilo Web Awọn Imudara Iṣẹ (WSE) API. Fi awọn asọye silẹ ti o ba lo awọn iṣẹ WCF ati pe kii ṣe fifi sori ẹrọ Web Awọn ilọsiwaju iṣẹ (WSE) ->
3. Uncomment abala ti o tẹle apẹẹrẹ kọọkan ti laini asọye:
   <section name=”microsoft.web.awọn iṣẹ2″ … >webAwọn iṣẹ>web.awọn iṣẹ2>
   Akiyesi: AwọnwebAwọn iṣẹ> ano lati wa ni uncommented ni a ọmọ tiweb>.

Tito leto gedu fun awọn Web API Services
O gbọdọ ṣeto awọn log file ona ati log ipele. Awọn ipele log jẹ akopọ. Fun example, ti o ba pato ipele 3, lẹhinna awọn ipele 1, 2, ati 3 ti wa ni ibuwolu wọle. Ipele log aiyipada jẹ 8.

1. Ṣatunkọ awọn web awọn iṣẹ Web.konfigi. Ipo aiyipada ni:
   APICP Web Awọn iṣẹWeb.konfigi
2. Ṣeto WọleFileOna. Awọn aiyipada iye ni APIAPIlogs. 3. Ṣeto LogLevel. Awọn iye to wulo ni:
   0 = Ko si wíwọlé
   1 = Orisun ohun ati ọna
   2 = Ifiranṣẹ aṣiṣe
   3 = Awọn paramita igbewọle
   4 = Awọn ipadabọ
   5 = Ikilọ
   8 = Aye ayẹwo

Tito leto foju liana ìfàṣẹsí fun awọn Web API Services
O gbọdọ jẹ ki iraye si alailorukọ ṣiṣẹ ati mu ifọwọsi Windows Integrated kuro fun CP naaWebItọsọna foju iṣẹ ni Awọn Iṣẹ Alaye Ayelujara (IIS). Fun alaye diẹ sii, wo Microsoft IIS iwe.
Tito leto database asopọ eto fun awọn Web API Services
Lo IwUlO Eto Wiwọle lati encrypt awọn eto asopọ data data ninu Web API Services Web.konfigi file. Fun alaye diẹ sii, wa fun “Ṣiṣeto Awọn Eto Asopọ data Iṣeduro” ni Itọsọna fifi sori aaye Changepoint.
Tito leto ìfàṣẹsí fun Changepoint WCF Web Awọn iṣẹ
O le tunto Ijeri Ohun elo ati ami ẹyọkan (SSO) fun Changepoint WCF Web Awọn iṣẹ.
Awọn aṣayan imuse atẹle wa ni lilo Iṣẹ Tokini Aabo (STS):

• SSO lilo ISAPI SSL iyan
• SSO nipa lilo WS-Federation (ADFS 2.0) SSL beere fun

Ti o ba nilo SSL, iwe afọwọkọ iṣeto ni idaniloju pe o ti lo.
Awọn iwe afọwọkọ iṣeto fun ISAPI ati ijẹrisi ohun elo le mu SSL ṣiṣẹ ni yiyan.
Tito leto ìfàṣẹsí ohun elo fun WCF Web Awọn iṣẹ
Iru ijẹrisi aiyipada fun Changepoint WCF Web Awọn iṣẹ jẹ ijẹrisi ohun elo.
Lo awọn ilana ni apakan yii lati:

• tunto Changepoint WCF Web Awọn iṣẹ lati lo ìfàṣẹsí ohun elo pẹlu SSL
• yi pada Changepoint WCF Web Awọn iṣẹ to ìfàṣẹsí ohun elo lẹhin ti ntẹriba muse ọkan ninu awọn SSO imuse

Tunto PowerShell

1. Ṣii ibeere Windows PowerShell kan.
2. Ṣatunṣe eto imulo ipaniyan:
   Ṣeto-Ipaṣẹ Ilana Ailopin

Stage 1 Gba iṣeto ni sile
Pinnu awọn iye fun awọn paramita iṣeto ni.

Paramita	Apejuwe
WebIṣẹ_Ona	Ipo ti Changepoint WCF Web Awọn iṣẹ web ohun elo files. Aiyipada: \API\CP Web Awọn iṣẹ
Ijẹrisi iṣẹ_ Oruko	Orukọ ijẹrisi ti yoo ṣee lo lati jẹri iṣẹ naa si awọn alabara nipa lilo ipo aabo ifiranṣẹ. Aiyipada: "CN=ChangepointAPICertificate" Orukọ ijẹrisi.
beere HTTPS	Beere HTTPS (Otitọ/Iro) Aiyipada: Eke.

Stage 2 Ṣiṣẹ awọn iwe afọwọkọ iṣeto ni
Lo awọn iye fun awọn paramita iṣeto ni lati yipada iṣeto ni ti awọn webojula.

1.  Ṣii ibeere PowerShell kan.
   Akiyesi: Ti olupin rẹ ba ni Iṣakoso Akọọlẹ Olumulo ṣiṣẹ, o gbọdọ ṣii PowerShell tọ nipa lilo awọn igbanilaaye alabojuto ti o ga.
2. Lilö kiri si CP web Ilana iṣeto iṣẹ, aiyipada:
   Iṣeto niCPWebIṣẹ
3.  Ṣiṣẹ ./Configuration_AppAuth.ps1
4. Tẹle awọn itọsona.

Ṣiṣeto ami-iwọle ẹyọkan (SSO) fun WCF Web Awọn iṣẹ
Tunto PowerShell

1. Ṣii ibeere Windows PowerShell kan.
2. Ṣatunṣe eto imulo ipaniyan:
   Ṣeto-Ipaṣẹ Ilana Ailopin

Ṣiṣeto SSO nipa lilo ISAPI fun WCF Web Awọn iṣẹ
Stage 1 Gba iṣeto ni sile
Pinnu awọn iye fun awọn ipilẹ iṣeto ni atẹle.

Paramita	Apejuwe
WebIṣẹ_Ona	Ipo ti Changepoint WCF Web Awọn iṣẹ web ohun elo files. Aiyipada: \API\CP Web Awọn iṣẹ
beere HTTPS	Beere HTTPS (Otitọ/Iro). Aiyipada: Eke.
Ayipada_RSA_ Kuki_Iyipada	Orukọ ijẹrisi ti o lo fun fifi ẹnọ kọ nkan Kuki. Aiyipada: "CN=ChangepointAPICertificate" Orukọ ijẹrisi.
Certificate_Orukọ Iṣẹ	Tẹ orukọ ijẹrisi sii ti yoo lo lati jẹri iṣẹ naa si awọn alabara nipa lilo ipo aabo ifiranṣẹ. Aiyipada: "CN=ChangepointAPICertificate" Orukọ ijẹrisi.
Wíwọlé Certificate_Oruko	Tẹ orukọ ijẹrisi fawabale sii. Eyi ni orukọ ijẹrisi ti o lo fun wíwọlé awọn ifiranṣẹ. Aiyipada: "CN=ChangepointAPICertificate" Orukọ ijẹrisi.
ISAPI_Ipo	Ipo ISAPI. Aiyipada: NT
ISAPI_Akọsori	Akọsori ti a lo nigbati ISAPI_Mode jẹ "HEADER", fun example, ofo.
ClaimType	Tẹ SSO ​​Clam Type. Aiyipada: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ṣiṣẹ awọn iwe afọwọkọ iṣeto ni

1. Ṣii ibeere PowerShell kan.
   Akiyesi: Ti olupin rẹ ba ni Iṣakoso Akọọlẹ Olumulo ṣiṣẹ, o gbọdọ ṣii PowerShell tọ nipa lilo awọn igbanilaaye alabojuto ti o ga.
2. Lilö kiri si CP web Ilana iṣeto iṣẹ, aiyipada:
   Iṣeto niCPWebIṣẹ
3. Ṣiṣẹ: ./Configuration_SSO_ISAPI.ps1
4. Tẹle awọn itọsona.

Ṣiṣeto SSO nipa lilo WS-Federation (ADFS 2.0) fun WCF Web Awọn iṣẹ
Stage 1 Gba iṣeto ni sile
Ṣe ipinnu awọn iye fun awọn paramita iṣeto ni tabili, ni isalẹ. Rii daju pe ADFS_Server_URI wa ni agbegbe Intranet ti ẹrọ aṣawakiri opin olumulo.
Akiyesi: Nipa aiyipada, a tunto Changepoint lati ṣe imudojuiwọn awọn bọtini ita gbangba ti a lo lati fowo si awọn ami aabo nipa lilo iwe-ipamọ metadata federation ti a tẹjade. Ninu ADFS eyi ni:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Ni awọn igba miiran o le ma ṣee ṣe lati de ọdọ olupin ADFS lati aaye Change web olupin nitorina o yoo ni lati ṣe imudojuiwọn iṣeto ni ọwọ lẹhin ṣiṣe iwe afọwọkọ iṣeto. Fun ẹkunrẹrẹ, wo “Afọwọṣe imudojuiwọn awọn bọtini gbangba” ni oju-iwe 12.

Paramita	Apejuwe
WebIṣẹ_Ona	Ipo ti Changepoint WCF Web Awọn iṣẹ web ohun elo files. Aiyipada: \API\CP Web Awọn iṣẹ
WebIṣẹ_URI	Idanimọ agbegbe ti o lo fun Changepoint WCF Web Awọn iṣẹ. Fun example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Kukisi_Transform	Orukọ ijẹrisi ti o lo fun fifi ẹnọ kọ nkan Kuki. Aiyipada: "CN=ChangepointApiCertificate" Orukọ ijẹrisi.
Certificate_Orukọ Iṣẹ	Orukọ ijẹrisi ti yoo ṣee lo lati jẹri iṣẹ naa si awọn alabara nipa lilo ipo aabo ifiranṣẹ. Aiyipada: "CN=ChangepointApiCertificate" Orukọ ijẹrisi.
Wíwọlé Certificate_Oruko	Orukọ ijẹrisi ti o lo fun wíwọlé awọn ifiranṣẹ. Aiyipada: “CN=ChangepointApiCertificate” Orukọ ijẹrisi ti lo.
ADFS_ Orukọ Iṣẹ Iṣẹ Federation	Orukọ Iṣẹ Federation. Lati gba orukọ naa: Lati olupin ADFS, Lọlẹ ADFS 2.0 console console. • Yan ADFS 2.0 lati inu akojọ aṣayan osi. • Lati awọn Action PAN yan Ṣatunkọ Federation Service Properties. Orukọ Iṣẹ Federation wa lori taabu Gbogbogbo.
ClaimType	SSO nipe Iru. Awọn aiyipada ni: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ṣiṣẹ awọn iwe afọwọkọ iṣeto ni
Tunto awọn webojula lilo awọn iye fun awọn paramita iṣeto ni.

1. Ṣii ibeere PowerShell kan.
   Akiyesi: Ti olupin rẹ ba ni Iṣakoso Akọọlẹ Olumulo ṣiṣẹ, o gbọdọ ṣii PowerShell tọ nipa lilo awọn igbanilaaye alabojuto ti o ga.
2. Lilö kiri si Changepoint web Ilana iṣeto iṣẹ, aiyipada: Iṣeto niCPWebIṣẹ
3.  Ṣiṣẹ: ./Configuration_SSO_ADFS.ps1
4. Tẹle awọn itọsona.

Stage 3 Ṣẹda igbẹkẹle ẹgbẹ ti o gbẹkẹle
Ṣẹda Igbekele Party Gbẹkẹle ni ADFS 2.0 Console.

1. Lori olupin ADFS rẹ, ṣe ifilọlẹ console ADFS 2.0.
2. Yan Ise > Fi Igbekele Ẹgbẹ Gbẹkẹle kun.
3. Tẹ Bẹrẹ.
4. Yan Gbe wọle data nipa ẹgbẹ ti o gbẹkẹle ti a tẹjade lori ayelujara tabi lori nẹtiwọki agbegbe kan.
5. Tẹ adirẹsi metadata Federation, lẹhinna tẹ Itele, fun example:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Tẹ orukọ Ifihan sii, fun apẹẹrẹ Changepoint WCF API, ki o tẹ Itele, Next, Next, lẹhinna Pade.
7. Ṣafikun Ofin Ipe fun Ẹgbẹ Igbẹkẹle Changepoint ti o wa loke. Fun Changepoint, orukọ ofin Ipe aiyipada jẹ “UPN”.
8. Ṣe maapu Iwa LDAP naa “Orukọ-Oluṣe-Oluṣe” si Iru Ipe Ti Njade “* UPN” tabi “UPN”.

Ti n ṣe imudojuiwọn awọn bọtini gbangba pẹlu ọwọ
Lati gba Atanpako Ibuwọlu Olupin ADFS

1. Lati olupin ADFS, Lọlẹ ADFS 2.0 console console.
2. Yan Iṣẹ > Awọn iwe-ẹri, ki o si tẹ iwe-ẹri Ibuwọlu Tokini lẹẹmeji.
3. Yan Awọn alaye taabu.
4. Yan aaye Atanpako.
5. Lati gba iye atanpako, yọ gbogbo awọn alafo kuro pẹlu aaye akọkọ.

Lati mu imudojuiwọn naa Web.konfigi file

1. Ṣatunkọ ADFS web.konfigi. Ipo aiyipada ni:
   EnterpriseRP-STS_ADFS
2. Labẹ awọn ano, wa ida:FederationMetadataLocation bọtini ati ki o ko awọn oniwe-iye:
   
3. Labẹ , ri awọn eroja ki o si ropo rẹ pẹlu awọn wọnyi: https://ADFS_Federation.ServiceName/adfs/services/trust>>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Ṣe idanwo asopọ COM API

1. Ṣiṣe Apo Idanwo API. Ipo aiyipada ni:
   APIAPI ComponentsApiTestKit.exe.
2. Tẹ Okun Asopọ> Encrypter.
3. Ninu aaye Okun Awọn Isopọ Ọrọ Plain:
   a. Rọpo SERVERNAME ati DATABASENAME pẹlu alaye data data rẹ.
   b. Rọpo USERID ati PASSWORD pẹlu alaye akọọlẹ olumulo alabojuto data rẹ.
   c. Tẹ iye akoko ipari bi o ṣe nilo.
4. Tẹ Encrypt.
5. Ni aaye Okun Asopọ ti paroko, daakọ ọrọ naa.
6. Pa apoti ibanisọrọ naa.
7. Lori akojọ Apo Idanwo API, tẹ Asopọ> COM Asopọmọra Asopọmọra API.
8. Ninu taabu Ẹya lọwọlọwọ, lẹẹmọ okun asopọ ti paroko sinu aaye Okun Asopọ.
9. Ni awọn LoginId ati Ọrọigbaniwọle aaye, tẹ awọn wiwọle ID ati ọrọigbaniwọle fun nyin Changepoint iroyin.
10. Ni aaye Loglevel (0-8), pato ipele ti alaye aṣiṣe lati da pada ni COM API log file ti abajade idanwo ba fihan iṣoro kan pẹlu asopọ.
    0 = Ko si wíwọlé
    1 = Orisun ohun ati ọna
    2 = Ifiranṣẹ aṣiṣe
    3 = Awọn paramita igbewọle
    4 = Awọn ipadabọ
    5 = Ikilọ
    8 = Aye ayẹwo
    Aiyipada jẹ 8.
11. Tẹ Sopọ.
    Ti asopọ naa ba ṣaṣeyọri, ifiranṣẹ aṣeyọri yoo han ni aaye Abajade. Ti asopọ ba kuna, ṣayẹwo COM API log file fun awọn aṣiṣe. Awọn aiyipada ipo ti awọn log file ni APIAPIlogs.

Ṣiṣayẹwo ẹya ti awọn paati API ti a fi sori ẹrọ
O le lo ohun elo oluṣayẹwo ẹya lati gba awọn alaye nipa awọn paati ti a fi sii, pẹlu ẹya itusilẹ ati ọna.

1. Ṣiṣe CPVersionChecker.exe. Ọna aiyipada ni: APIAPI irinše
2. Tẹ Ka.

Yiyewo awọn version of awọn Web API Services

1. Lọlẹ Internet Explorer lati olupin ibi ti awọn Web API Awọn iṣẹ ti fi sori ẹrọ, ki o si tẹ adirẹsi sii:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  ibi ti ibudo ni awọn nọmba ibudo ti awọn webAaye ibi ti o ti fi CP sori ẹrọWebItọsọna foju iṣẹ.
2. Lori oju-iwe WSLogin, tẹ ọna asopọ GetVersion.
3. Tẹ ipe.

Idanwo awọn Web Asopọ API Services

1. Lọlẹ Internet Explorer lati olupin ibi ti awọn Web API Awọn iṣẹ ti fi sori ẹrọ, ki o si tẹ adirẹsi sii: http://localhost.port/CPWeb.Service/WSLogin.asmx  ibi ti ibudo ni awọn nọmba ibudo ti awọn webAaye ibi ti o ti fi CP sori ẹrọWebItọsọna foju iṣẹ.
2. Lori oju-iwe WSLogin tẹ ọna asopọ TestConnection.
3. Tẹ ipe. 4. Ninu awọn abajade idanwo:

• Ti o ba jẹ ano jẹ eke, igbeyewo asopọ aseyori.
• Ti o ba jẹ ano jẹ otitọ, asopọ idanwo kuna. Fun diẹ ẹ sii
  alaye lori awọn idi fun ikuna, wo awọn ati eroja ninu awọn igbeyewo esi, ati ki o ṣayẹwo awọn API àkọọlẹ. Ọna aiyipada si awọn akọọlẹ API jẹ: APIAPIlogs

Eto soke awọn Web API Awọn iṣẹ lori olupin ede

1. Lati ran awọn Changepoint Web API Awọn iṣẹ lori olupin ede, o gbọdọ fikun tabi mu imudojuiwọn naa tag ninu awọn Web API Services web.konfigi. Awọn aiyipada ipo ti awọn Web.konfigi file ni: APICP Web Awọn iṣẹWeb.konfigi
2. Ti o ba ti tag ti wa tẹlẹ, rii daju pe aṣa mejeeji ati awọn abuda uiCulture jẹ “en-US.”
3. Ti o ba ti tag ko si tẹlẹ, fi awọn wọnyi , ọrọìwòye, ati eroja si awọnweb> ipade:web>
   Awọn aṣayan Ipilẹ wiwo: Ṣeto muna =”otitọ”lati gba gbogbo awọn iyipada iru data nibiti pipadanu data le waye. Ṣeto fojuhan =”otitọ” lati fi ipa mu ikede gbogbo awọn oniyipada. –>
4. Tun IIS tun bẹrẹ.