Umhlahlandlela Wokufaka we-API
I-Reference Guide
Iphoyinti lokushintsha 2021
© 2021 Changepoint Canada ULC Wonke amalungelo agodliwe. AMALUNGELO KAHULUMENI WASE-US-Ukusebenzisa, ukuphindaphinda, noma ukudalulwa nguHulumeni wase-US kungaphansi kwemikhawulo njengoba ibekwe esivumelwaneni selayisense ye-Changepoint Canada ULC futhi njengoba kunikeziwe ku-DFARS 227.7202-1(a) kanye no-227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, noma FAR 52.227-14 (ALT III), njengoba kusebenza. Lo mkhiqizo uqukethe ulwazi oluyimfihlo kanye nezimfihlo zohwebo ze-Changepoint Canada ULC. Ukudalula akuvunyelwe ngaphandle kwemvume ebhaliwe ye-Changepoint Canada ULC. Ukusetshenziswa kwalo mkhiqizo kungaphansi kwemigomo nemibandela yeSivumelwano Selayisense yomsebenzisi ne-Changepoint Canada ULC. Amadokhumenti angaphinda akhiqizwe Ngumnikazi Welayisensi ukuze asetshenziswe ngaphakathi. Okuqukethwe kulo mbhalo akumele kushintshwe, kulungiswe noma kushintshwe ngaphandle kwemvume ebhaliwe ye-Changepoint Canada ULC. I-Changepoint Canada ULC ingashintsha okuqukethwe okucaciswe lapha nganoma yisiphi isikhathi, ngesaziso noma ngaphandle kwesaziso.
Ifaka i-Changepoint API
Mayelana nokufaka i-Changepoint API
I-Changepoint API iyatholakala njenge-COM API, isevisi ye-Windows Communication Foundation (WCF) futhi, ngokuhambisana nokubuyela emuva, njenge- Web Isevisi Yokuthuthukisa Izinsizakalo (i-WSE). Ukuze uthole ulwazi mayelana ne-Changepoint API, bona i-Changepoint API Reference. Ukuze uthole amanothi okuthuthukisa, izixwayiso nezinkinga ezaziwayo, bona Amanothi Okukhishwa kumafolda eqembu kokuthi Changepoint.
Ukuthuthukisa i-Changepoint API
Uma uthuthukela ekukhishweni kwangaphambilini kwe-Changepoint, sebenzisa Iphaneli Yokulawula YeWindows ukuze ukhiphe inguqulo yangaphambilini ye-Changepoint API kanye nezingxenye zayo ngaphambi kokufaka le nguqulo.
Izidingo ze-Changepoint API
Kufanele ufake i-Changepoint ngaphambi kokufaka i-Changepoint API. Ukuthola izidingo zesoftware, bheka i-Changepoint Software Compatibility Matrix, etholakala kufolda yeqembu lamanothi okukhishwa ka-2021 kanye ne-Patches ku-Changepoint.
File izivumelwano zendlela
Kuwo wonke lo mbhalo, lezi zimiso ezilandelayo zisetshenziselwa izindlela ezivamile:
- Indlela eyinhloko yokufakwa kwe-Changepoint.
Indlela ezenzakalelayo ithi:
C: Uhlelo Files (x86)ChangepointChangepoint - Indawo eyimpande yezinsiza ezijwayelekile ze-Changepoint, njengensiza Yezilungiselelo zokungena.
Indlela ezenzakalelayo ithi:
C: Uhlelo Files (x86) Okuvamile FilesChangepointChangepoint
Ifaka i-Changepoint API
- Kusukela ku-Changepoint API media root directory, sebenzisa setup.exe.
- Landela imiyalo kuze kuvele isikrini esithi Khetha Izici.
- Khetha izici ofuna ukuzifaka, bese uchofoza Okulandelayo.
- Khetha ifolda yendawo ye-API, ezenzakalelayo API, bese uchofoza Okulandelayo.
Qaphela: Isisetshenziswa se-Changepoint Login Settings sifakiwe Izilungiselelo zokungena, kungakhathaliseki ifolda oyibalulayo. - Uma ukhethe i- Web I-API Yezinsizakalo: a. Lapho Khetha
a Web Isikrini sesayithi siyavela, khetha a website ukuze wengeze uhla lwemibhalo olubonakalayo, bese uchofoza Okulandelayo.
b. Chofoza Okulandelayo ukuze uqhubeke. 6. Uma ukufakwa kwe-API sekuqediwe, chofoza okuthi Qeda.
Ilungiselela i-Changepoint API ukuthi yazi inqolobane
Ukuze ulungiselele i-Changepoint API ukuthi iqaphele inqolobane, buyisela amanani "enqolobaneni. Iphasiwedi” kanye “nenqolobane. Amaseva” okhiye ku-CP Web AmasevisiWeb.config file ngamavelu asetshenziswa kuBhizinisiWeb.config file.
Inika amandla Web Izithuthukisi Zezinsizakalo (WSE)
- Hlela i- Web.config file okwe web amasevisi. Indawo ezenzakalelayo ithi:
I-APICP Web AmasevisiWeb.config - Thola izimo ezintathu zomugqa wokuphawula olandelayo:
< !– Yekisa ukuphawula ngento elandelayo uma usebenzisa Web I-Service Enhancements (WSE) API. Shiya amazwana uma usebenzisa izinsiza ze-WCF futhi ungawafaki Web Izithuthukisi Zesevisi (WSE) -> - Susa amazwana kusici esilandela isenzakalo ngasinye somugqa wamazwana:
<section name=”microsoft.web.izinkonzo2″ ... >webIzinkonzo>web.izinkonzo2>
Qaphela: IwebServices> into okufanele ingaphawulwa ingane kaweb>.
Ilungiselela ukungena kwe- Web Services API
Kufanele usethe ilogu file indlela kanye namazinga welogi. Amaleveli elogi ayanqwabelana. Okwesiboneloample, uma ucacisa ileveli 3, amazinga 1, 2, no-3 afakiwe. Izinga lelogi elizenzakalelayo ngu-8.
- Hlela i- web amasevisi Web.config. Indawo ezenzakalelayo ithi:
I-APICP Web AmasevisiWeb.config - Setha IlogiFileIndlela. Inani elizenzakalelayo lithi APIAPILogs. 3. Setha i-LogLevel. Amanani avumelekile yilawa:
0 = Akukho ukugawulwa kwemithi
1 = Umthombo wento nendlela
2 = Umlayezo wephutha
3 = Amapharamitha wokufaka
4 = Ukubuyisela
5 = Isexwayiso
8 = Indawo yokuhlola
Ilungiselela ukufakazela ubuqiniso benkomba ye- Web Services API
Kufanele unike amandla ukufinyelela okungaziwa futhi ukhubaze ukuqinisekiswa kwe-Windows Ehlanganisiwe ye-CPWebInkomba yesevisi ye-virtual ku-Internet Information Services (IIS). Ukuze uthole ulwazi olwengeziwe, bheka imibhalo ye-Microsoft IIS.
Ilungiselela izilungiselelo zokuxhuma kusizindalwazi se- Web Services API
Sebenzisa insiza Yezilungiselelo Zokungena ukuze ubethele izilungiselelo zokuxhuma kusizindalwazi ku- Web Services API Web.config file. Ukuze uthole ulwazi olwengeziwe, sesha “Ukulungiselela Izilungiselelo Zokuxhunywa Kwesizindalwazi” Kumhlahlandlela Wokufaka we-Changepoint.
Ilungiselela ukuqinisekiswa kwe-Changepoint WCF Web Amasevisi
Ungalungisa Ukuqinisekiswa Kwesicelo kanye nokungena ngemvume okukodwa (i-SSO) kwe-Changepoint WCF Web Amasevisi.
Izinketho zokuqalisa ezilandelayo ziyatholakala kusetshenziswa Isevisi Yethokheni Evikelekile (STS):
- SSO usebenzisa i-ISAPI SSL ngokuzithandela
- Kudingeka i-SSO kusetshenziswa i-WS-Federation (ADFS 2.0) SSL
Uma i-SSL idingeka, isikripthi sokumisa siqinisekisa ukuthi siyasetshenziswa.
Imibhalo yokumisa ye-ISAPI kanye nokuqinisekiswa kohlelo lokusebenza kunganika amandla i-SSL ngokuzithandela.
Ilungiselela ukufakazela ubuqiniso bohlelo lwe-WCF Web Amasevisi
Uhlobo lokuqinisekisa oluzenzakalelayo lwe-Changepoint WCF Web Amasevisi uwukufakazela ubuqiniso bohlelo lokusebenza.
Sebenzisa izinqubo ezikulesi sigaba ukuze:
- lungisa i-Changepoint WCF Web Izinsiza zokusebenzisa ukufakazela ubuqiniso kohlelo lokusebenza nge-SSL
- buyisela i-Changepoint WCF Web Amasevisi okufakazela ubuqiniso bohlelo lokusebenza ngemva kokusebenzisa okunye kokusetshenziswa kwe-SSO
Lungiselela i-PowerShell
- Vula i-Windows PowerShell prompt.
- Shintsha inqubomgomo yokwenza:
I-Set-ExecutionPolicy Ayikhawulelwe
Stage 1 Qoqa amapharamitha wokumisa
Nquma amanani emingcele yokumisa.
| Ipharamitha | Incazelo |
| WebIndlela_yesevisi | Izindawo zokuhlala e-Changepoint WCF Web Amasevisi web isicelo files. Okuzenzakalelayo: \API\CP Web Amasevisi |
| ServiceCertificate_ Igama |
Igama lesitifiketi elizosetshenziswa ukuze kugunyazwe isevisi kumakhasimende kusetshenziswa Imodi yokuvikeleka komlayezo. Okuzenzakalelayo: Igama lesitifiketi se-“CN=ChangepointAPICertificate”. |
| zidinga i-HTTPS | Idinga i-HTTPS (Iqiniso/Amanga) Okuzenzakalelayo: Amanga. |
Stage 2 Yenza izikripthi zokumisa
Sebenzisa amanani emingcele yokumisa ukuze uguqule ukucushwa kwe- webamasayithi.
- Vula ukwaziswa kwe-PowerShell.
Qaphela: Uma iseva yakho ine-Akhawunti Yomsebenzisi enikwe amandla, kufanele uvule umyalo we-PowerShell usebenzisa izimvume zomlawuli eziphakeme. - Zulazulela ku-CP web uhla lwemibhalo lokumisa isevisi, okuzenzakalelayo:
I-ConfigurationCPWebIsevisi - Sebenzisa ./Configuration_AppAuth.ps1
- Landela imiyalelo.
Ilungiselela ukungena ngemvume okukodwa (SSO) kwe-WCF Web Amasevisi
Lungiselela i-PowerShell
- Vula i-Windows PowerShell prompt.
- Shintsha inqubomgomo yokwenza:
I-Set-ExecutionPolicy Ayikhawulelwe
Ilungiselela i-SSO kusetshenziswa i-ISAPI ye-WCF Web Amasevisi
Stage 1 Qoqa amapharamitha wokumisa
Nquma amanani emingcele yokucushwa elandelayo.
| Ipharamitha | Incazelo |
| WebIndlela_yesevisi | Le yindawo ka Changepoint WCF Web Amasevisi web isicelo files. Okuzenzakalelayo: \API\CP Web Amasevisi |
| zidinga i-HTTPS | Idinga i-HTTPS (Iqiniso/Amanga). Okuzenzakalelayo: Amanga. |
| Changepoint_RSA_ Ikhukhi_Guqula |
Igama lesitifiketi osisebenzisela ukubethela kwekhukhi. Okuzenzakalelayo: Igama lesitifiketi se-“CN=ChangepointAPICertificate”. |
| ServiceCertificate_Name | Faka igama lesitifiketi elizosetshenziswa ukuze kugunyazwe isevisi kumakhasimende usebenzisa Imodi yokuvikeleka komlayezo. Okuzenzakalelayo: Igama lesitifiketi se-“CN=ChangepointAPICertificate”. |
| SigningCertificate_Name | Faka igama lesitifiketi sokusayina. Leli igama lesitifiketi osisebenzisela ukusayina imilayezo. Okuzenzakalelayo: Igama lesitifiketi se-“CN=ChangepointAPICertificate”. |
| ISAPI_Mode | Imodi ye-ISAPI. Okuzenzakalelayo: NT |
| ISAPI_Header | Unhlokweni osetshenziswa uma ISAPI_Mode ithi “HEADER”, isiboneloample, akunalutho. |
| ClaimType | Faka Uhlobo Lwesimangalo se-SSO. Okuzenzakalelayo: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Yenza izikripthi zokumisa
- Vula ukwaziswa kwe-PowerShell.
Qaphela: Uma iseva yakho ine-Akhawunti Yomsebenzisi enikwe amandla, kufanele uvule umyalo we-PowerShell usebenzisa izimvume zomlawuli eziphakeme. - Zulazulela ku-CP web uhla lwemibhalo lokumisa isevisi, okuzenzakalelayo:
I-ConfigurationCPWebIsevisi - Qalisa: ./Configuration_SSO_ISAPI.ps1
- Landela imiyalelo.
Ilungiselela i-SSO kusetshenziswa i-WS-Federation (ADFS 2.0) ye-WCF Web Amasevisi
Stage 1 Qoqa amapharamitha wokumisa
Nquma amanani emingcele yokumisa kuthebula, ngezansi. Qinisekisa ukuthi i-ADFS_Server_URI isendaweni ye-Intranet yesiphequluli somsebenzisi wokugcina.
Qaphela: Ngokuzenzakalelayo, i-Changepoint ilungiselelwe ukuthi ibuyekeze ngokuzenzakalelayo okhiye basesidlangalaleni abasetshenziselwa ukusayina amathokheni okuphepha ngokusebenzisa idokhumenti yemethadatha yenhlangano eshicilelwe. Ku-ADFS yilokhu:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Kwezinye izimo kungase kungenzeki ukufinyelela iseva ye-ADFS usuka ku-Changepoint web iseva ngakho-ke kuzodingeka ukuthi ubuyekeze ukucushwa mathupha ngemva kokusebenzisa iskripthi sokumisa. Ukuze uthole imininingwane, bheka “Ukubuyekeza ngokwenza okhiye basesidlangalaleni” ekhasini 12.
| Ipharamitha | Incazelo |
| WebIndlela_yesevisi | Izindawo zokuhlala e-Changepoint WCF Web Amasevisi web isicelo files. Okuzenzakalelayo: \API\CP Web Amasevisi |
| WebIsevisi_URI | Inkomba yesizinda oyisebenzisela i-Changepoint WCF Web Amasevisi. Okwesiboneloample., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_ Cookie_Transform | Igama lesitifiketi osisebenzisela ukubethela kwekhukhi. Okuzenzakalelayo: Igama lesitifiketi se-“CN=ChangepointApiCertificate”. |
| ServiceCertificate_Name | Igama lesitifiketi elizosetshenziswa ukuze kugunyazwe isevisi kumakhasimende kusetshenziswa Imodi yokuvikeleka komlayezo. Okuzenzakalelayo: Igama lesitifiketi se-“CN=ChangepointApiCertificate”. |
| SigningCertificate_Name | Igama lesitifiketi osisebenzisela ukusayina imilayezo. Okuzenzakalelayo: Igama lesitifiketi elithi “CN=ChangepointApiCertificate” liyasetshenziswa. |
| ADFS_ FederationServiceName | Igama Lesevisi Yenhlangano. Ukuze uthole igama: Kusuka kuseva ye-ADFS, Yethula i-ADFS 2.0 Management console. •Khetha i-ADFS 2.0 kumenyu engakwesokunxele. •Kufasitelana lesenzo khetha Hlela Izakhiwo Zesevisi Yenhlangano. Igama Lesevisi Yenhlangano likuthebhu ethi Okujwayelekile. |
| ClaimType | Uhlobo lwesimangalo se-SSO. Okuzenzakalelayo yilokhu: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Yenza izikripthi zokumisa
Lungiselela i- webamasayithi asebenzisa amanani emingcele yokumisa.
- Vula ukwaziswa kwe-PowerShell.
Qaphela: Uma iseva yakho ine-Akhawunti Yomsebenzisi enikwe amandla, kufanele uvule umyalo we-PowerShell usebenzisa izimvume zomlawuli eziphakeme. - Zulazulela ku-Changepoint web uhla lwemibhalo lokumisa isevisi, okuzenzakalelayo: I-ConfigurationCPWebIsevisi
- Qalisa: ./Configuration_SSO_ADFS.ps1
- Landela imiyalelo.
Stage 3 Dala ukwethenjwa kweqembu elithembekile
Dala i-Relying Party Trust kukhonsoli ye-ADFS 2.0.
- Kuseva yakho ye-ADFS, vula ikhonsoli ye-ADFS 2.0.
- Khetha Isenzo > Engeza I-Relying Party Trust.
- Chofoza Qala.
- Khetha ukungenisa idatha mayelana neqembu elithembekile elishicilelwe ku-inthanethi noma kunethiwekhi yendawo.
- Faka ikheli lemethadatha ye-Federation, bese uchofoza Okulandelayo, ngokwesiboneloample:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Faka igama lokubonisa, isb. Changepoint WCF API, bese uchofoza Okulandelayo, Okulandelayo, Okulandelayo, bese Vala.
- Engeza Umthetho Wesimangalo Wenhlangano Ethembele Ye-Changepoint engenhla. Ku-Changepoint, igama lomthetho wesimangalo elizenzakalelayo lithi “UPN”.
- Mepha Isibaluli se-LDAP esithi “Igama-Lomsebenzisi-Uthishanhloko” Ohlotsheni Lwesimangalo Esiphumayo “* UPN” noma “UPN”.
Ukubuyekeza ngokwenza okhiye basesidlangalaleni
Ukuze uthole i-ADFS Server Token Signing Thumbprint
- Kusuka kuseva ye-ADFS, Yethula i-ADFS 2.0 Management console.
- Khetha Isevisi > Izitifiketi, bese uchofoza kabili isitifiketi sokusayina Ithokheni.
- Khetha ithebhu Yemininingwane.
- Khetha inkambu ye-Thumbprint.
- Ukuze uthole inani lezigxivizo zesithupha, susa zonke izikhala ezihlanganisa nesikhala sokuqala.
Ukuze ubuyekeze i- Web.config file
- Hlela i-ADFS web.config. Indawo ezenzakalelayo ithi:
I-EnterpriseRP-STS_ADFS - Ngaphansi kwe- isici, thola i-ida:FederationMetadataLocation key futhi usule inani layo:
- Ngaphansi , thola i bese uyishintsha ngokulandelayo: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust”/>
Ihlola uxhumano lwe-COM API
- Qalisa Ikhithi Yokuhlola ye-API. Indawo ezenzakalelayo ithi:
I-API ComponentsApiTestKit.exe. - Chofoza Intambo Yokuxhuma > Isibetheli.
- Kunkambu Yentambo Yokuxhunywa Kombhalo Ongenalutho:
a. Faka esikhundleni i-SERVERNAME kanye ne-DATABASENAME ngolwazi lwakho lesizindalwazi.
b. Faka esikhundleni se-USERID kanye ne-PASSWORD ngolwazi lwe-akhawunti yakho yomsebenzisi yomqondisi wesizindalwazi.
c. Faka inani lesikhathi sokuvala njengoba kudingeka. - Chofoza okuthi Bethela.
- Kunkambu Yezintambo Zokuxhuma Ezibethelwe, kopisha umbhalo.
- Vala ibhokisi lengxoxo.
- Kumenyu yekhithi yokuhlola ye-API, chofoza Uxhumo > Isihloli Soxhumano Lwe-COM API.
- Kuthebhu Yenguqulo Yamanje, namathisela iyunithi yezinhlamvu yokuxhuma ebethelwe kunkambu Yentambo Yokuxhuma.
- Ezinkambini ze-LoginId kanye nephasiwedi, faka i-ID yokungena nephasiwedi ye-akhawunti yakho ye-Changepoint.
- Kunkambu ye-Loglevel (0-8), cacisa izinga lolwazi lwephutha oluzobuyiswa kulogu ye-COM API file uma umphumela wokuhlola ubonisa inkinga ngoxhumo.
0 = Akukho ukugawulwa kwemithi
1 = Umthombo wento nendlela
2 = Umlayezo wephutha
3 = Amapharamitha wokufaka
4 = Ukubuyisela
5 = Isexwayiso
8 = Indawo yokuhlola
Okuzenzakalelayo kungama-8. - Chofoza Xhuma.
Uma ukuxhumeka kuphumelele, umlayezo wempumelelo uyavezwa endaweni ethi Umphumela. Uma ukuxhumeka kuhlulekile, hlola ilogu ye-COM API file ngamaphutha. Indawo ezenzakalelayo yelogi file kuyinto APIAPILogs.
Ihlola inguqulo yezingxenye ze-API ezifakiwe
Ungasebenzisa insiza yokuhlola inguqulo ukuze uthole imininingwane mayelana nezingxenye ezifakiwe, okuhlanganisa inguqulo yokukhishwa nendlela.
- Qalisa i-CPVersionChecker.exe. Indlela ezenzakalelayo ithi: Izingxenye ze-API API
- Chofoza Funda.
Ihlola inguqulo ye Web Services API
- Yethula i-Internet Explorer kusuka kuseva lapho i Web I-API Yezinsizakalo ifakiwe, bese ufaka ikheli:
http://localhost.port/CPWeb.Service/WSLogin.asmx lapho imbobo inombolo yembobo ye webindawo ofake kuyo i-CPWebInsizakalo yemibhalo ebonakalayo. - Ekhasini le-WSLogin, chofoza isixhumanisi se-GetVersion.
- Chofoza u-Invoke.
Ukuhlola i Web Uxhumano lwe-API yezinsizakalo
- Yethula i-Internet Explorer kusuka kuseva lapho i Web I-API Yezinsizakalo ifakiwe, bese ufaka ikheli: http://localhost.port/CPWeb.Service/WSLogin.asmx lapho imbobo inombolo yembobo ye webindawo ofake kuyo i-CPWebInsizakalo yemibhalo ebonakalayo.
- Ekhasini le-WSLogin chofoza isixhumanisi se-TestConnection.
- Chofoza u-Invoke. 4. Emiphumeleni yokuhlolwa:
- Uma isici singamanga, uxhumano lokuhlola luphumelele.
- Uma isici siyiqiniso, uxhumano lokuhlola lwehlulekile. Ukuze uthole okwengeziwe
ulwazi ngezizathu zokwehluleka, bheka futhi izici emiphumeleni yokuhlola, futhi uhlole amalogi e-API. Indlela ezenzakalelayo eya kumalogi e-API ithi: APIAPILogs
Ukusetha i- Web I-API Yezinsizakalo kuseva yolimi
- Ukuze usebenzise i-Changepoint Web Izinsizakalo ze-API kuseva yolimi, kufanele wengeze noma ubuyekeze i tag kwe Web Services API web.config. Indawo ezenzakalelayo ye- Web.config file ngu: I-APICP Web AmasevisiWeb.config
- Uma i tag isivele ikhona, qinisekisa ukuthi zombili izimfanelo zesiko kanye ne-uiCulture “ziyi-en-US.”
- Uma i tag alikho kakade, engeza okulandelayo , phawula, futhi izakhi kuweb> indawo:web>
Izinketho Ezibonakalayo Eziyisisekelo: Setha okuqinile=” okuyiqiniso” ukuze ungavumeli zonke izinhlobo zokuguqulwa kwedatha lapho ukulahleka kwedatha kungenzeka khona. Setha okucacile=”iqiniso” ukuze uphoqelele ukumenyezelwa kwazo zonke izinto eziguquguqukayo. –> - Qala kabusha i-IIS.
Amadokhumenti / Izinsiza
 |
Changepoint API Software [pdf] Umhlahlandlela wokufaka I-API, Isofthiwe, Isofthiwe ye-API |
