Mwongozo wa Ufungaji wa API
Mwongozo wa Marejeleo
Mabadiliko ya 2021

© 2021 Changepoint Kanada ULC Haki zote zimehifadhiwa. HAKI ZA SERIKALI YA SERIKALI YA MAREKANI-Matumizi, kurudufu, au ufichuzi wa Serikali ya Marekani inategemea vikwazo kama ilivyobainishwa katika makubaliano ya leseni ya Changepoint Kanada ya ULC na kama inavyotolewa katika DFARS 227.7202-1(a) na 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, au FAR 52.227-14 (ALT III), inavyotumika. Bidhaa hii ina maelezo ya siri na siri za biashara za Changepoint Canada ULC. Ufumbuzi hauruhusiwi bila idhini ya maandishi ya Changepoint Canada ULC. Matumizi ya bidhaa hii yanategemea sheria na masharti ya Makubaliano ya Leseni ya mtumiaji na Changepoint Kanada ULC. Hati zinaweza kutolewa tena na Mwenye Leseni kwa matumizi ya ndani pekee. Maudhui ya waraka huu hayawezi kubadilishwa, kurekebishwa au kubadilishwa bila idhini ya maandishi ya Changepoint Canada ULC. Changepoint Kanada ULC inaweza kubadilisha maudhui yaliyotajwa humu wakati wowote, kwa au bila taarifa.

Inasakinisha API ya Changepoint

Kuhusu kusakinisha API ya Changepoint
API ya Changepoint inapatikana kama COM API, huduma ya Windows Communication Foundation (WCF) na, kwa utangamano wa nyuma, kama Web Huduma ya Uboreshaji wa Huduma (WSE). Kwa habari kuhusu API ya Changepoint, angalia Rejea ya API ya Changepoint. Kwa madokezo ya kuboresha, tahadhari na masuala yanayojulikana, angalia Vidokezo vya Kutolewa kwenye folda za timu katika Changepoint.
Kuboresha API ya Changepoint
Ikiwa unaboresha kutoka toleo la awali la Changepoint, tumia Paneli ya Kudhibiti ya Windows ili kusanidua toleo la awali la API ya Changepoint na vijenzi vyake kabla ya kusakinisha toleo hili.
Mahitaji ya API ya Changepoint
Lazima usakinishe Changepoint kabla ya kusakinisha Changepoint API. Kwa mahitaji ya programu, angalia Matrix ya Upatanifu wa Programu ya Changepoint, ambayo inapatikana katika folda ya timu ya Vidokezo vya Kutolewa na Viraka vya 2021 katika Changepoint.
File mikataba ya njia
Katika hati hii yote, kanuni zifuatazo hutumiwa kwa njia za kawaida:

• Njia ya mizizi ya usakinishaji wa Changepoint.
  Njia chaguo-msingi ni:
  C: Mpango Files (x86)ChangepointChangepoint
• Mahali pa msingi kwa huduma za kawaida za Changepoint, kama vile matumizi ya Mipangilio ya Kuingia.
  Njia chaguo-msingi ni:
  C: Mpango Files (x86) Ya kawaida FilesChangepointChangepoint

Inasakinisha API ya Changepoint

1. Kutoka kwa saraka ya mizizi ya media ya Changepoint API, endesha setup.exe.
2. Fuata mawaidha hadi skrini ya Chagua Vipengele itaonekana.
3. Chagua vipengele unavyotaka kusakinisha, kisha ubofye Inayofuata.
4. Chagua folda lengwa la API, chaguomsingi API, na ubofye Ijayo.
   Kumbuka: Huduma ya Mipangilio ya Kuingia ya Changepoint imewekwa ndani Mipangilio ya Kuingia, bila kujali folda lengwa unayobainisha.
5. Ikiwa umechagua Web API ya Huduma: a. Wakati Chagua
   a Web Skrini ya tovuti inaonekana, chagua a webtovuti ya kuongeza saraka halisi, na kisha ubofye Ijayo.
   b. Bofya Inayofuata ili kuendelea. 6. Wakati usakinishaji wa API umekamilika, bofya Maliza.

Kusanidi API ya Changepoint ili kufahamu akiba
Ili kusanidi API ya Changepoint kuwa na ufahamu wa kache, badilisha maadili ya "cache. Nenosiri" na "cache. Vifunguo vya seva kwenye CP Web HudumaWeb.config file na maadili yanayotumika katika BiasharaWeb.config file.
Inawezesha Web Uboreshaji wa Huduma (WSE)

1. Hariri Web.config file kwa web huduma. Mahali chaguo-msingi ni:
   APICP Web HudumaWeb.config
2. Tafuta mifano mitatu ya mstari wa maoni ufuatao:
   < !- Ondoa maoni kwa kipengele kifuatacho ikiwa unatumia Web API ya Maboresho ya Huduma (WSE). Acha maoni ikiwa unatumia huduma za WCF na hausakinishi Web Uboreshaji wa Huduma (WSE) ->
3. Toa maoni kwa kipengele kinachofuata kila mfano wa mstari wa maoni:
   <section name="microsoft.web.huduma2″ … >webHuduma>web.huduma2>
   Kumbuka: ThewebServices> kipengele ambacho hakitatolewa maoni ni mtoto waweb>.

Inasanidi ukataji miti kwa Web API ya Huduma
Lazima uweke logi file njia na viwango vya logi. Viwango vya kumbukumbu ni limbikizo. Kwa mfanoample, ikiwa unataja kiwango cha 3, basi viwango vya 1, 2, na 3 vimeingia. Kiwango cha logi chaguo-msingi ni 8.

1. Hariri web huduma Web.config. Mahali chaguo-msingi ni:
   APICP Web HudumaWeb.config
2. Weka LogiFileNjia. Thamani chaguo-msingi ni APILogs. 3. Weka LogLevel. Thamani halali ni:
   0 = Hakuna ukataji miti
   1 = Chanzo kitu na mbinu
   2 = Ujumbe wa hitilafu
   3 = Vigezo vya kuingiza
   4 = Marudio
   5 = Onyo
   8 = Kituo cha ukaguzi

Inasanidi uthibitishaji wa saraka halisi ya faili ya Web API ya Huduma
Lazima uwashe ufikiaji usiojulikana na uzime uthibitishaji wa Windows Integrated kwa CPWebSaraka pepe ya huduma katika Huduma za Habari za Mtandao (IIS). Kwa habari zaidi, angalia hati za Microsoft IIS.
Inasanidi mipangilio ya muunganisho wa hifadhidata kwa ajili ya Web API ya Huduma
Tumia matumizi ya Mipangilio ya Kuingia ili kusimba kwa njia fiche mipangilio ya muunganisho wa hifadhidata katika Web API ya Huduma Web.config file. Kwa maelezo zaidi, tafuta "Kuweka Mipangilio ya Muunganisho wa Hifadhidata" katika Mwongozo wa Usakinishaji wa Changepoint.
Inasanidi uthibitishaji wa Changepoint WCF Web Huduma
Unaweza kusanidi Uthibitishaji wa Programu na kuingia mara moja (SSO) kwa Changepoint WCF Web Huduma.
Chaguzi zifuatazo za utekelezaji zinapatikana kwa kutumia Huduma ya Tokeni Salama (STS):

• SSO kwa kutumia ISAPI SSL ya hiari
• SSO kwa kutumia WS-Federation (ADFS 2.0) SSL inahitajika

Ikiwa SSL inahitajika, hati ya usanidi inahakikisha kuwa inatumika.
Hati za usanidi za ISAPI na uthibitishaji wa programu zinaweza kuwezesha SSL kwa hiari.
Inasanidi uthibitishaji wa programu kwa WCF Web Huduma
Aina chaguo-msingi ya uthibitishaji wa Changepoint WCF Web Huduma ni uthibitishaji wa programu.
Tumia taratibu katika sehemu hii kwa:

• sanidi Changepoint WCF Web Huduma za kutumia uthibitishaji wa programu na SSL
• rudisha Changepoint WCF Web Huduma za uthibitishaji wa programu baada ya kutekeleza mojawapo ya utekelezaji wa SSO

Sanidi PowerShell

1. Fungua haraka ya Windows PowerShell.
2. Rekebisha sera ya utekelezaji:
   Set-ExecutionPolicy Haina Kizuizi

Stage 1 Kusanya vigezo vya usanidi
Amua maadili ya vigezo vya usanidi.

Kigezo	Maelezo
WebNjia_ya_Huduma	Eneo la Changepoint WCF Web Huduma web maombi files. Chaguomsingi: \API\CP Web Huduma
Cheti cha Huduma_ Jina	Jina la cheti litakalotumika kuthibitisha huduma kwa wateja kwa kutumia hali ya usalama ya Ujumbe. Chaguomsingi: Jina la Cheti cha “CN=ChangepointAPICertificate”.
zinahitaji HTTPS	Inahitaji HTTPS (Kweli/Uongo) Chaguomsingi: Si kweli.

Stage 2 Tekeleza hati za usanidi
Tumia maadili kwa vigezo vya usanidi ili kurekebisha usanidi wa webtovuti.

1.  Fungua kidokezo cha PowerShell.
   Kumbuka: Ikiwa seva yako imewezeshwa Udhibiti wa Akaunti ya Mtumiaji, lazima ufungue kidokezo cha PowerShell kwa kutumia ruhusa zilizoinuliwa za msimamizi.
2. Nenda kwenye CP web saraka ya usanidi wa huduma, chaguo-msingi:
   ConfigurationCPWebHuduma
3.  Tekeleza ./Configuration_AppAuth.ps1
4. Fuata mawaidha.

Inasanidi kuingia mara moja (SSO) kwa WCF Web Huduma
Sanidi PowerShell

1. Fungua haraka ya Windows PowerShell.
2. Rekebisha sera ya utekelezaji:
   Set-ExecutionPolicy Haina Kizuizi

Inasanidi SSO kwa kutumia ISAPI ya WCF Web Huduma
Stage 1 Kusanya vigezo vya usanidi
Amua maadili ya vigezo vifuatavyo vya usanidi.

Kigezo	Maelezo
WebNjia_ya_Huduma	Eneo la Changepoint WCF Web Huduma web maombi files. Chaguomsingi: \API\CP Web Huduma
zinahitaji HTTPS	Inahitaji HTTPS (Kweli/Uongo). Chaguomsingi: Si kweli.
Changepoint_RSA_ Kuki_Kubadilisha	Jina la cheti unachotumia kwa usimbaji fiche wa Vidakuzi. Chaguomsingi: Jina la Cheti cha “CN=ChangepointAPICertificate”.
ServiceCertificate_Jina	Weka jina la cheti litakalotumika kuthibitisha huduma kwa wateja kwa kutumia Hali ya usalama ya Ujumbe. Chaguomsingi: Jina la Cheti cha “CN=ChangepointAPICertificate”.
SainiCheti_Jina	Weka jina la cheti cha kusaini. Hili ndilo jina la cheti unachotumia kusaini ujumbe. Chaguomsingi: Jina la Cheti cha “CN=ChangepointAPICertificate”.
ISAPI_Mode	Njia ya ISAPI. Chaguomsingi: NT
ISAPI_Header	Kijajuu kinachotumika wakati ISAPI_Mode ni "HEADER", kwa mfanoample, tupu.
Aina ya Madai	Weka Aina ya Dai la SSO. Chaguomsingi: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Tekeleza hati za usanidi

1. Fungua kidokezo cha PowerShell.
   Kumbuka: Ikiwa seva yako imewezeshwa Udhibiti wa Akaunti ya Mtumiaji, lazima ufungue kidokezo cha PowerShell kwa kutumia ruhusa zilizoinuliwa za msimamizi.
2. Nenda kwenye CP web saraka ya usanidi wa huduma, chaguo-msingi:
   ConfigurationCPWebHuduma
3. Tekeleza: ./Configuration_SSO_ISAPI.ps1
4. Fuata mawaidha.

Kusanidi SSO kwa kutumia WS-Federation (ADFS 2.0) kwa WCF Web Huduma
Stage 1 Kusanya vigezo vya usanidi
Amua maadili ya vigezo vya usanidi kwenye jedwali, hapa chini. Hakikisha kuwa ADFS_Server_URI iko katika eneo la Intraneti ya kivinjari cha mtumiaji wa mwisho.
Kumbuka: Kwa chaguomsingi, Changepoint imesanidiwa kusasisha kiotomatiki funguo za umma zinazotumiwa kutia sahihi tokeni za usalama kwa kutumia hati ya metadata ya shirikisho iliyochapishwa. Katika ADFS hii ni:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Katika baadhi ya matukio inaweza kuwa haiwezekani kufikia seva ya ADFS kutoka kwa Changepoint web seva kwa hivyo itabidi usasishe usanidi mwenyewe baada ya kuendesha hati ya usanidi. Kwa maelezo, angalia "Kusasisha funguo za umma wewe mwenyewe" kwenye ukurasa wa 12.

Kigezo	Maelezo
WebNjia_ya_Huduma	Eneo la Changepoint WCF Web Huduma web maombi files. Chaguomsingi: \API\CP Web Huduma
WebHuduma_URI	Kitambulisho cha kikoa unachotumia kwa Changepoint WCF Web Huduma. Kwa mfanoample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Jina la cheti unachotumia kwa usimbaji fiche wa Vidakuzi. Chaguomsingi: Jina la Cheti cha “CN=ChangepointApiCertificate”.
ServiceCertificate_Jina	Jina la cheti litakalotumika kuthibitisha huduma kwa wateja kwa kutumia hali ya usalama ya Ujumbe. Chaguomsingi: Jina la Cheti cha “CN=ChangepointApiCertificate”.
SainiCheti_Jina	Jina la cheti unachotumia kusaini ujumbe. Chaguomsingi: Jina la Cheti cha “CN=ChangepointApiCertificate” linatumika.
ADFS_ FederationServiceName	Jina la Huduma ya Shirikisho. Ili kupata jina: Kutoka kwa seva ya ADFS, Zindua koni ya Usimamizi ya ADFS 2.0. •Chagua ADFS 2.0 kutoka kwenye menyu ya kushoto. •Kutoka kwa kidirisha cha Kitendo chagua Badilisha Sifa za Huduma ya Shirikisho. Jina la Huduma ya Shirikisho liko kwenye kichupo cha Jumla.
Aina ya Madai	Aina ya Madai ya SSO. Chaguo msingi ni: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Tekeleza hati za usanidi
Sanidi webtovuti zinazotumia maadili ya vigezo vya usanidi.

1. Fungua kidokezo cha PowerShell.
   Kumbuka: Ikiwa seva yako imewezeshwa Udhibiti wa Akaunti ya Mtumiaji, lazima ufungue kidokezo cha PowerShell kwa kutumia ruhusa zilizoinuliwa za msimamizi.
2. Nenda kwenye sehemu ya Mabadiliko web saraka ya usanidi wa huduma, chaguo-msingi: ConfigurationCPWebHuduma
3.  Tekeleza: ./Configuration_SSO_ADFS.ps1
4. Fuata mawaidha.

Stage 3 Unda imani ya chama tegemezi
Unda Trusting Party Trust katika ADFS 2.0 Console.

1. Kwenye seva yako ya ADFS, zindua koni ya ADFS 2.0.
2. Chagua Kitendo > Ongeza Imani ya Chama Cha Kuegemea.
3. Bofya Anza.
4. Chagua Leta data kuhusu mhusika tegemezi iliyochapishwa mtandaoni au kwenye mtandao wa ndani.
5. Ingiza anwani ya metadata ya Shirikisho, kisha ubofye Ijayo, kwa mfanoample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Ingiza jina la Onyesho, kwa mfano Changepoint WCF API, na ubofye Inayofuata, Inayofuata, Inayofuata, kisha Funga.
7. Ongeza Sheria ya Madai kwa Chama Cha Kuegemea cha Changepoint hapo juu. Kwa Changepoint, jina la sheria ya dai chaguo-msingi ni "UPN".
8. Ramani ya Sifa ya LDAP "Jina-Mkuu-Mtumiaji" kwa Aina ya Dai Linalotoka "* UPN" au "UPN".

Inasasisha funguo za umma mwenyewe
Ili kupata Kijipicha cha Kusaini Tokeni ya Seva ya ADFS

1. Kutoka kwa seva ya ADFS, Zindua kiweko cha Usimamizi cha ADFS 2.0.
2. Chagua Huduma > Vyeti, na ubofye mara mbili cheti cha kusaini Tokeni.
3. Chagua kichupo cha Maelezo.
4. Chagua sehemu ya vidole.
5. Ili kupata thamani ya kidole gumba, ondoa nafasi zote ikijumuisha nafasi ya kwanza.

Ili kusasisha Web.config file

1. Badilisha ADFS web.config. Mahali chaguo-msingi ni:
   EnterpriseRP-STS_ADFS
2. Chini ya kipengele, pata kitufe cha ida:FederationMetadataLocation na ufute thamani yake:
   
3. Chini ya , tafuta kipengele na ubadilishe na zifuatazo: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

Inajaribu muunganisho wa API ya COM

1. Endesha Kifaa cha Kujaribu cha API. Mahali chaguo-msingi ni:
   API ComponentsApiTestKit.exe.
2. Bofya Kamba ya Muunganisho > Kisimbaji.
3. Katika sehemu ya Kamba ya Viunganisho vya Maandishi Matupu:
   a. Badilisha SERVERNAME na DATABASENAME na maelezo yako ya hifadhidata.
   b. Badilisha USERID na PASSWORD na maelezo ya akaunti yako ya msimamizi wa hifadhidata.
   c. Weka thamani ya muda wa kuisha inavyohitajika.
4. Bofya Ficha.
5. Katika sehemu ya Kamba ya Muunganisho Uliosimbwa kwa Njia Fiche, nakili maandishi.
6. Funga kisanduku cha mazungumzo.
7. Kwenye menyu ya API Test Kit, bofya Muunganisho > Kijaribu Kiunganishi cha API ya COM.
8. Katika kichupo cha Toleo la Sasa, bandika kamba ya muunganisho iliyosimbwa kwa njia fiche kwenye sehemu ya Kamba ya Muunganisho.
9. Katika sehemu za Kitambulisho cha Kuingia na Nenosiri, ingiza kitambulisho cha kuingia na nenosiri la akaunti yako ya Changepoint.
10. Katika uga wa Loglevel (0-8), taja kiwango cha maelezo ya hitilafu yatakayorejeshwa katika kumbukumbu ya COM API. file ikiwa matokeo ya jaribio yanaonyesha shida na unganisho.
    0 = Hakuna ukataji miti
    1 = Chanzo kitu na mbinu
    2 = Ujumbe wa hitilafu
    3 = Vigezo vya kuingiza
    4 = Marudio
    5 = Onyo
    8 = Kituo cha ukaguzi
    Chaguo-msingi ni 8.
11. Bofya Unganisha.
    Ikiwa muunganisho ulifanikiwa, ujumbe wa mafanikio unaonyeshwa kwenye uwanja wa Matokeo. Ikiwa muunganisho umeshindwa, angalia logi ya COM API file kwa makosa. Eneo la msingi la logi file ni APILogs.

Kuangalia toleo la vipengee vya API vilivyosakinishwa
Unaweza kutumia kipengele cha kukagua toleo ili kupata maelezo kuhusu vipengee vilivyosakinishwa, ikiwa ni pamoja na toleo la toleo na njia.

1. Endesha CPVersionChecker.exe. Njia chaguo-msingi ni: Vipengele vya API
2. Bofya Soma.

Kuangalia toleo la Web API ya Huduma

1. Zindua Internet Explorer kutoka kwa seva ambapo faili ya Web API ya Huduma imesakinishwa, na ingiza anwani:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  ambapo bandari ni nambari ya bandari ya webtovuti ambapo ulisakinisha CPWebSaraka pepe ya huduma.
2. Kwenye ukurasa wa WSLogin, bofya kiungo cha GetVersion.
3. Bofya Omba.

Mtihani wa Web Uunganisho wa API ya huduma

1. Zindua Internet Explorer kutoka kwa seva ambapo faili ya Web API ya Huduma imesakinishwa, na ingiza anwani: http://localhost.port/CPWeb.Service/WSLogin.asmx  ambapo bandari ni nambari ya bandari ya webtovuti ambapo ulisakinisha CPWebSaraka pepe ya huduma.
2. Kwenye ukurasa wa WSLogin bofya kiungo cha TestConnection.
3. Bofya Omba. 4. Katika matokeo ya mtihani:

• Kama kipengele ni uongo, muunganisho wa jaribio umefaulu.
• Kama kipengele ni kweli, muunganisho wa jaribio umeshindwa. Kwa zaidi
  habari juu ya sababu za kushindwa, angalia na vipengele katika matokeo ya mtihani, na angalia kumbukumbu za API. Njia chaguo-msingi ya kumbukumbu za API ni: APILogs

Kuanzisha Web API ya huduma kwenye seva ya lugha

1. Ili kupeleka Changepoint Web API ya huduma kwenye seva ya lugha, lazima uongeze au usasishe tag katika Web API ya Huduma web.config. Mahali chaguo-msingi ya Web.config file ni: APICP Web HudumaWeb.config
2. Ikiwa tag tayari ipo, hakikisha kwamba sifa zote za utamaduni na uiCulture ni "en-US."
3. Ikiwa tag haipo tayari, ongeza yafuatayo , maoni, na vipengele kwaweb> nodi:web>
   Chaguo za Msingi Zinazoonekana: Weka kali=” kweli” ili kutoruhusu ugeuzaji wa aina zote za data ambapo upotezaji wa data unaweza kutokea. Weka wazi = "kweli" ili kulazimisha kutangazwa kwa vigezo vyote. ->
4. Anzisha upya IIS.

Nyaraka / Rasilimali

Programu ya API ya Changepoint [pdf] Mwongozo wa Ufungaji API, Programu, Programu ya API

Marejeleo

• Mwongozo wa Mtumiaji