Changepoint API sagteware installasie gids

API-installasiegids
Verwysingsgids
Veranderpunt 2021

© 2021 Changepoint Canada ULC Alle regte voorbehou. VS REGERINGSREGTE-Gebruik, duplisering of openbaarmaking deur die Amerikaanse regering is onderhewig aan beperkings soos uiteengesit in die Changepoint Canada ULC lisensie-ooreenkoms en soos voorsien in DFARS 227.7202-1(a) en 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19, of FAR 52.227-14 (ALT III), soos van toepassing. Hierdie produk bevat vertroulike inligting en handelsgeheime van Changepoint Canada ULC. Openbaarmaking word verbied sonder die vooraf uitdruklike skriftelike toestemming van Changepoint Canada ULC. Gebruik van hierdie produk is onderhewig aan die bepalings en voorwaardes van die gebruiker se lisensie-ooreenkoms met Changepoint Canada ULC. Dokumentasie mag slegs deur lisensiehouer vir interne gebruik gereproduseer word. Die inhoud van hierdie dokument mag nie verander, gewysig of verander word sonder die uitdruklike skriftelike toestemming van Changepoint Canada ULC nie. Changepoint Canada ULC kan die inhoud wat hierin gespesifiseer word enige tyd verander, met of sonder kennisgewing.

Die installering van die Changepoint API

Oor die installering van die Changepoint API
Die Changepoint API is beskikbaar as 'n COM API, 'n Windows Communication Foundation (WCF) diens en, vir terugwaartse versoenbaarheid, as 'n Web Services Enhancements (WSE) diens. Vir inligting oor die Changepoint API, sien die Changepoint API Verwysing. Vir opgraderingsnotas, waarskuwings en bekende probleme, sien die vrystellingsnotas in spanvouers in Changepoint.
Opgradering van die Changepoint API
As jy vanaf 'n vorige weergawe van Changepoint opgradeer, gebruik die Windows-kontrolepaneel om die vorige weergawe van die Changepoint API en sy komponente te verwyder voordat jy hierdie weergawe installeer.
Veranderpunt API vereistes
Jy moet Changepoint installeer voordat jy die Changepoint API installeer. Vir sagtewarevereistes, sien die Changepoint Software Compatibility Matrix, wat beskikbaar is in die 2021 Release Notes and Patches-spangids in Changepoint.
File pad konvensies
Regdeur hierdie dokument word die volgende konvensies vir algemene paaie gebruik:

• Die wortelpad van die Changepoint-installasie.
  Die verstek pad is:
  C: Program Files (x86)VeranderpuntVeranderpunt
• Die wortelligging vir algemene Changepoint-nutsprogramme, soos die Aantekeninstellings-nutsding.
  Die verstek pad is:
  C: Program Files (x86) Algemeen FilesChangepointChangepoint

Die installering van die Changepoint API

1. Begin setup.exe vanaf die Changepoint API-mediahoofgids.
2. Volg die aanwysings totdat die Kies kenmerke-skerm verskyn.
3. Kies die kenmerke wat jy wil installeer en klik dan op Volgende.
4. Kies die API-bestemmingsmap, verstek API, en klik op Volgende.
   Let wel: Die Changepoint Login Settings-nutsding is geïnstalleer in LoginSettings, ongeag die bestemmingslêergids wat jy spesifiseer.
5. As jy die Web Dienste API: a. Wanneer die Kies
   a Web Werfskerm verskyn, kies 'n webwebwerf om die virtuele gids by te voeg, en klik dan op Volgende.
   b. Klik Volgende om voort te gaan. 6. Wanneer die installasie van die API voltooi is, klik Voltooi.

Konfigureer die Changepoint API om kasbewus te wees
Om die Changepoint API op te stel om kasbewus te wees, vervang die waardes vir die "cache. Wagwoord" en "kas. Servers” sleutels in die CP Web DiensteWeb.config file met die waardes wat in die Onderneming gebruik wordWeb.config file.
Aktiveer Web Diensteverbeterings (WSE)

1. Wysig die Web.config file vir web dienste. Die verstek ligging is:
   APICP Web DiensteWeb.config
2. Soek die drie gevalle van die volgende kommentaarreël:
   < !– Maak kommentaar op die volgende element as jy gebruik Web Service Enhancements (WSE) API. Laat kommentaar as jy WCF-dienste gebruik en nie installeer nie Web Diensverbeterings (WSE) –>
3. Ontmerk die element wat op elke geval van die kommentaarreël volg:
   <section name=”microsoft.web.dienste2″ … >webDienste>web.dienste2>
   Let wel: DiewebServices> element wat nie kommentaar gelewer moet word nie, is 'n kind vanweb>.

Konfigureer logboek vir die Web Dienste API
Jy moet die log opstel file pad en log vlakke. Die log vlakke is kumulatief. Byvoorbeeldample, as jy vlak 3 spesifiseer, dan word vlakke 1, 2 en 3 aangeteken. Die verstek logvlak is 8.

1. Wysig die web dienste Web.config. Die verstek ligging is:
   APICP Web DiensteWeb.config
2. Stel die logFilePad. Die verstekwaarde is APIAPILogs. 3. Stel die LogLevel. Die geldige waardes is:
   0 = Geen aantekening nie
   1 = Bronobjek en metode
   2 = Foutboodskap
   3 = Invoer parameters
   4 = Opbrengste
   5 = Waarskuwing
   8 = Kontrolepunt

Konfigureer virtuele gids-verifikasie vir die Web Dienste API
Jy moet anonieme toegang aktiveer en Geïntegreerde Windows-verifikasie vir die CP deaktiveerWebDiens virtuele gids in Internet Information Services (IIS). Vir meer inligting, sien die Microsoft IIS-dokumentasie.
Die opstel van databasisverbindinginstellings vir die Web Dienste API
Gebruik die Login Settings-nutsding om die databasisverbindinginstellings in die Web Dienste API Web.config file. Vir meer inligting, soek vir "Configuring Database Connection Settings" in die Changepoint Installation Guide.
Konfigureer stawing vir Changepoint WCF Web Dienste
U kan toepassingstawing en enkelaanmelding (SSO) vir Changepoint WCF opstel Web Dienste.
Die volgende implementeringsopsies is beskikbaar met behulp van Secure Token Service (STS):

• SSO met ISAPI SSL opsioneel
• SSO met WS-Federation (ADFS 2.0) SSL vereis

As SSL vereis word, verseker die konfigurasieskrip dat dit gebruik word.
Die konfigurasie skrifte vir ISAPI en toepassing verifikasie kan opsioneel SSL aktiveer.
Opstel van toepassingstawing vir WCF Web Dienste
Die verstek verifikasie tipe vir Changepoint WCF Web Dienste is toepassingstawing.
Gebruik die prosedures in hierdie afdeling om:

• stel Changepoint WCF in Web Dienste om toepassingstawing met SSL te gebruik
• verander Veranderpunt WCF terug Web Dienste aan toepassingstawing nadat een van die SSO-implementerings geïmplementeer is

Stel PowerShell op

1. Maak 'n Windows PowerShell-prompt oop.
2. Wysig die uitvoeringsbeleid:
   Stel-uitvoeringsbeleid onbeperk

Stage 1 Versamel konfigurasieparameters
Bepaal die waardes vir die konfigurasieparameters.

Parameter	Beskrywing
WebDienspad	Ligging van die Changepoint WCF Web Dienste web aansoek files. Verstek: \API\CP Web Dienste
Dienssertifikaat_ Naam	Sertifikaatnaam wat gebruik sal word om die diens aan kliënte te staaf deur Boodskapsekuriteitmodus te gebruik. Verstek: die "CN=ChangepointAPICertificate" Sertifikaatnaam.
vereis HTTPS	Vereis HTTPS (Waar/Onwaar) Verstek: Onwaar.

Stage 2 Voer konfigurasie skrifte uit
Gebruik die waardes vir die konfigurasieparameters om die konfigurasie van die webwerwe.

1.  Maak 'n PowerShell-prompt oop.
   Let wel: As u bediener Gebruikersrekeningbeheer geaktiveer het, moet u die PowerShell-prompt oopmaak met verhoogde administrateurtoestemmings.
2. Navigeer na die CP web dienskonfigurasiegids, verstek:
   KonfigurasieCPWebDiens
3.  Voer ./Configuration_AppAuth.ps1 uit
4. Volg die aanwysings.

Opstel van enkelaanmelding (SSO) vir WCF Web Dienste
Stel PowerShell op

1. Maak 'n Windows PowerShell-prompt oop.
2. Wysig die uitvoeringsbeleid:
   Stel-uitvoeringsbeleid onbeperk

Konfigureer SSO met ISAPI vir WCF Web Dienste
Stage 1 Versamel konfigurasieparameters
Bepaal die waardes vir die volgende konfigurasieparameters.

Parameter	Beskrywing
WebDienspad	Die ligging van die Changepoint WCF Web Dienste web aansoek files. Verstek: \API\CP Web Dienste
vereis HTTPS	Vereis HTTPS (Waar/Onwaar). Verstek: Onwaar.
Veranderpunt_RSA_ Koekie_Transformeer	Die naam van die sertifikaat wat jy vir Koekie-enkripsie gebruik. Verstek: die "CN=ChangepointAPICertificate" Sertifikaatnaam.
Dienssertifikaat_Naam	Voer die sertifikaatnaam in wat gebruik sal word om die diens aan kliënte te verifieer deur Boodskapsekuriteitmodus te gebruik. Verstek: die "CN=ChangepointAPICertificate" Sertifikaatnaam.
SigningCertificate_Name	Voer die naam van die ondertekeningsertifikaat in. Dit is die naam van die sertifikaat wat jy gebruik om boodskappe te onderteken. Verstek: die "CN=ChangepointAPICertificate" Sertifikaatnaam.
ISAPI_Modus	Die ISAPI-modus. Verstek: NT
ISAPI_Header	Die kop wat gebruik word wanneer ISAPI_Mode "HEADER" is, bvample, leeg.
Eistipe	Voer die SSO-eistipe in. Verstek: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Voer konfigurasie skrifte uit

1. Maak 'n PowerShell-prompt oop.
   Let wel: As u bediener Gebruikersrekeningbeheer geaktiveer het, moet u die PowerShell-prompt oopmaak met verhoogde administrateurtoestemmings.
2. Navigeer na die CP web dienskonfigurasiegids, verstek:
   KonfigurasieCPWebDiens
3. Voer uit: ./Configuration_SSO_ISAPI.ps1
4. Volg die aanwysings.

Konfigureer SSO met WS-Federation (ADFS 2.0) vir WCF Web Dienste
Stage 1 Versamel konfigurasieparameters
Bepaal die waardes vir die konfigurasieparameters in die tabel hieronder. Maak seker dat die ADFS_Server_URI in die intranetsone van die eindgebruiker se blaaier is.
Let wel: By verstek is Changepoint opgestel om outomaties die publieke sleutels op te dateer wat gebruik word om sekuriteittokens te onderteken deur die gepubliseerde federasie-metadatadokument te gebruik. In ADFS is dit:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
In sommige gevalle is dit dalk nie moontlik om die ADFS-bediener vanaf die Changepoint te bereik nie web bediener sodat jy die konfigurasie handmatig moet opdateer nadat jy die konfigurasieskrip uitgevoer het. Vir besonderhede, sien "Opdateer publieke sleutels handmatig" op bladsy 12.

Parameter	Beskrywing
WebDienspad	Ligging van die Changepoint WCF Web Dienste web aansoek files. Verstek: \API\CP Web Dienste
WebDiens_URI	Domeinidentifiseerder wat jy vir Changepoint WCF gebruik Web Dienste. Byvoorbeeldample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Naam van die sertifikaat wat jy vir Koekie-enkripsie gebruik. Verstek: die "CN=ChangepointApiCertificate" Sertifikaatnaam.
Dienssertifikaat_Naam	Sertifikaatnaam wat gebruik sal word om die diens aan kliënte te staaf deur Boodskapsekuriteitmodus te gebruik. Verstek: die "CN=ChangepointApiCertificate" Sertifikaatnaam.
SigningCertificate_Name	Naam van die sertifikaat wat jy gebruik om boodskappe te onderteken. Verstek: die “CN=ChangepointApiCertificate” Sertifikaatnaam word gebruik.
ADFS_ FederationServiceName	Federasiediensnaam. Om die naam te kry: Begin ADFS 2.0 Bestuurskonsole vanaf die ADFS-bediener. •Kies ADFS 2.0 vanaf die linkerkieslys. • Kies Edit Federation Service Properties in die Aksie-paneel. Die Federasiediensnaam is op die Algemeen-oortjie.
Eistipe	SSO-eistipe. Die verstek is: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Voer konfigurasie skrifte uit
Stel die webwebwerwe wat die waardes vir die konfigurasieparameters gebruik.

1. Maak 'n PowerShell-prompt oop.
   Let wel: As u bediener Gebruikersrekeningbeheer geaktiveer het, moet u die PowerShell-prompt oopmaak met verhoogde administrateurtoestemmings.
2. Navigeer na die Veranderpunt web dienskonfigurasiegids, verstek: KonfigurasieCPWebDiens
3.  Voer uit: ./Configuration_SSO_ADFS.ps1
4. Volg die aanwysings.

Stage 3 Skep vertroue van die vertroue party
Skep die Relying Party Trust in ADFS 2.0 Console.

1. Begin die ADFS 2.0-konsole op jou ADFS-bediener.
2. Kies Aksie > Voeg Betroubare Party Trust by.
3. Klik Start.
4. Kies Voer data in oor die vertrouende party wat aanlyn of op 'n plaaslike netwerk gepubliseer is.
5. Voer die Federasie-metadata-adres in en klik dan Volgende, bvample:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Voer 'n vertoonnaam in, bv. Changepoint WCF API, en klik Volgende, Volgende, Volgende, dan Sluit.
7. Voeg 'n eisreël by vir die bogenoemde Veranderpunt-vertroue-party. Vir Changepoint is die verstek eisreëlnaam "UPN".
8. Kaart die LDAP-kenmerk “Gebruiker-hoofnaam” na uitgaande eistipe “* UPN” of “UPN”.

Werk publieke sleutels handmatig op
Om die ADFS Server Token Signing-duimafdruk te verkry

1. Begin ADFS 2.0 Bestuurskonsole vanaf die ADFS-bediener.
2. Kies Diens > Sertifikate, en dubbelklik op die Teken-ondertekeningsertifikaat.
3. Kies die Besonderhede-oortjie.
4. Kies die Duimafdruk-veld.
5. Om die duimafdrukwaarde te kry, verwyder al die spasies insluitend die eerste spasie.

Om die op te dateer Web.config file

1. Wysig die ADFS web.config. Die verstek ligging is:
   EnterpriseRP-STS_ADFS
2. Onder die element, vind die ida:FederationMetadataLocation-sleutel en maak die waarde daarvan skoon:
   
3. Onder , vind die element en vervang dit met die volgende: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust” />

Toets die COM API-verbinding

1. Begin die API-toetsstel. Die verstek ligging is:
   APIAPI ComponentsApiTestKit.exe.
2. Klik Connection String > Encrypter.
3. In die Plain Text Connections String veld:
   a. Vervang SERVERNAME en DATABASENAME met jou databasisinligting.
   b. Vervang USERID en WAGWOORD met jou databasis admin gebruiker rekening inligting.
   c. Voer die uittelwaarde in soos nodig.
4. Klik Enkripteer.
5. Kopieer die teks in die Geënkripteerde verbindingstring-veld.
6. Maak die dialoogkassie toe.
7. Op die API-toetsstel-kieslys, klik Connection > COM API Connection Tester.
8. In die Huidige weergawe-oortjie, plak die geënkripteerde verbindingstring in die Connection String-veld.
9. Tik die aanmeld-ID en wagwoord vir jou Changepoint-rekening in die LoginId- en Wagwoord-velde.
10. In die Loglevel (0-8)-veld, spesifiseer die vlak van foutinligting wat in die COM API-logboek teruggestuur moet word file as die toetsuitslag 'n probleem met die verbinding toon.
    0 = Geen aantekening nie
    1 = Bronobjek en metode
    2 = Foutboodskap
    3 = Invoer parameters
    4 = Opbrengste
    5 = Waarskuwing
    8 = Kontrolepunt
    Die verstek is 8.
11. Klik Koppel.
    As die verbinding suksesvol was, word 'n suksesboodskap in die Resultaat-veld vertoon. As die verbinding misluk het, gaan die COM API-logboek na file vir foute. Die verstekligging van die logboek file is APIAPILogs.

Gaan die weergawe van geïnstalleerde API-komponente na
U kan die weergawe-kontroler-nutsding gebruik om besonderhede oor die geïnstalleerde komponente te verkry, insluitend die vrystellingweergawe en -pad.

1. Begin CPVersionChecker.exe. Die verstek pad is: APIAPI-komponente
2. Klik Lees.

Kontroleer die weergawe van die Web Dienste API

1. Begin Internet Explorer vanaf die bediener waar die Web Services API is geïnstalleer, en voer die adres in:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  waar poort die poortnommer van die webwebwerf waar jy die CP geïnstalleer hetWebDiens virtuele gids.
2. Klik op die WSLogin-bladsy op die GetVersion-skakel.
3. Klik Oproep.

Toets die Web Dienste API-verbinding

1. Begin Internet Explorer vanaf die bediener waar die Web Services API is geïnstalleer, en voer die adres in: http://localhost.port/CPWeb.Service/WSLogin.asmx  waar poort die poortnommer van die webwebwerf waar jy die CP geïnstalleer hetWebDiens virtuele gids.
2. Klik op die WSLogin-bladsy op die TestConnection-skakel.
3. Klik Oproep. 4. In die toetsresultate:

• As element vals is, het die toetsverbinding geslaag.
• As element waar is, het die toetsverbinding misluk. Vir meer
  inligting oor die redes vir die mislukking, sien die en elemente in die toetsresultate, en gaan die API-logboeke na. Die verstekpad na die API-logboeke is: APIAPILogs

Die opstel van die Web Services API op 'n taalbediener

1. Om die Changepoint te ontplooi Web Services API op 'n taalbediener, moet jy die byvoeg of opdateer tag in die Web Dienste API web.config. Die verstek ligging van die Web.config file is: APICP Web DiensteWeb.config
2. As die tag reeds bestaan, maak seker dat beide kultuur- en uiCulture-kenmerke "en-US" is.
3. As die tag nie reeds bestaan ​​nie, voeg die volgende by , kommentaar, en elemente aan dieweb> node:web>
   Visual Basic-opsies: Stel streng = "waar" om alle datatipe-omskakelings waar dataverlies kan voorkom, te verbied. Stel eksplisiet = "waar" om verklaring van alle veranderlikes af te dwing. –>
4. Herbegin IIS.