Changepoint API -ohjelmiston asennusopas

API-asennusopas
Viiteopas
Muutospiste 2021

© 2021 Changepoint Canada ULC Kaikki oikeudet pidätetään. YHDYSVALTAIN HALLITUKSEN OIKEUDET – Yhdysvaltain hallituksen suorittama käyttö, kopioiminen tai paljastaminen on Changepoint Canada ULC -lisenssisopimuksen ja DFARS 227.7202-1(a) ja 227.7202-3(a) (1995) mukaisten rajoitusten alaista, DFARS 252.227-7013(c)(1)(ii) (OKT 1988), FAR 12.212(a) (1995), FAR 52.227-19 tai FAR 52.227-14 (ALT III), soveltuvin osin. Tämä tuote sisältää Changepoint Canada ULC:n luottamuksellisia tietoja ja liikesalaisuuksia. Tietojen paljastaminen on kiellettyä ilman Changepoint Canada ULC:n etukäteen antamaa nimenomaista kirjallista lupaa. Tämän tuotteen käyttöön sovelletaan käyttäjän Changepoint Canada ULC:n kanssa tehdyn lisenssisopimuksen ehtoja. Vain lisenssinsaaja saa kopioida asiakirjoja sisäiseen käyttöön. Tämän asiakirjan sisältöä ei saa muuttaa, muokata tai muuttaa ilman Changepoint Canada ULC:n nimenomaista kirjallista lupaa. Changepoint Canada ULC voi muuttaa tässä määriteltyä sisältöä milloin tahansa ilmoittamalla tai ilmoittamatta siitä.

Changepoint API:n asentaminen

Tietoja Changepoint API:n asentamisesta
Changepoint API on saatavilla COM API:na, Windows Communication Foundation (WCF) -palveluna ja taaksepäin yhteensopivuuden vuoksi Web Services Enhancements (WSE) -palvelu. Lisätietoja Changepoint API:sta on kohdassa Changepoint API Reference. Katso päivityshuomautukset, varoitukset ja tunnetut ongelmat Changepointin tiimikansioiden julkaisutiedoista.
Changepoint API:n päivittäminen
Jos olet päivittämässä aiemmasta Changepointin julkaisusta, poista Changepoint API:n ja sen komponenttien edellinen versio Windowsin Ohjauspaneelin avulla ennen tämän version asentamista.
Changepoint API -vaatimukset
Sinun on asennettava Changepoint ennen kuin asennat Changepoint API:n. Ohjelmistovaatimuksia varten katso Changepoint Software Compatibility Matrix, joka on saatavilla Changepointin 2021 Release Notes and Patches -tiimikansiossa.
File polkusopimukset
Tässä asiakirjassa käytetään seuraavia yleisiä polkuja koskevia sopimuksia:

• Changepoint-asennuksen juuripolku.
  Oletuspolku on:
  C: Ohjelma Files (x86)ChangepointChangepoint
• Yleisten Changepoint-apuohjelmien, kuten Kirjautumisasetukset-apuohjelman, juurisijainti.
  Oletuspolku on:
  C: Ohjelma Files (x86) Yleinen FilesChangepointChangepoint

Changepoint API:n asentaminen

1. Suorita Changepoint API -median juurihakemistosta setup.exe.
2. Noudata kehotteita, kunnes Select Features -näyttö tulee näkyviin.
3. Valitse asennettavat ominaisuudet ja napsauta sitten Seuraava.
4. Valitse oletusarvoisesti API-kohdekansio API ja napsauta Seuraava.
   Huomautus: Changepoint Login Settings -apuohjelma on asennettu LoginSettings, riippumatta määrittämästäsi kohdekansiosta.
5. Jos valitsit Web Services API: a. Kun Valitse
   a Web Sivustonäyttö tulee näkyviin, valitse a websivusto, johon virtuaalihakemisto lisätään, ja napsauta sitten Seuraava.
   b. Napsauta Seuraava jatkaaksesi. 6. Kun API:n asennus on valmis, napsauta Valmis.

Changepoint API:n määrittäminen välimuistitietoiseksi
Voit määrittää Changepoint API:n olemaan tietoinen välimuistista korvaamalla välimuistin arvot. Salasana" ja "välimuisti. Palvelimet” avaimet CP:ssä Web PalvelutWeb.config file Enterprisessa käytettyjen arvojen kanssaWeb.config file.
Otetaan käyttöön Web Palvelujen parannukset (WSE)

1. Muokkaa Web.config file varten web palvelut. Oletussijainti on:
   APICP Web PalvelutWeb.config
2. Etsi seuraavan kommenttirivin kolme esiintymää:
   < !– Poista seuraavan elementin kommentti, jos käytät sitä Web Service Enhancements (WSE) API. Jätä kommentit, jos käytät WCF-palveluita etkä asenna Web Palvelun parannukset (WSE) –>
3. Poista kommentit jokaista kommenttirivin esiintymää seuraavasta elementistä:
   <section name=”microsoft.web.services2″ … >webPalvelut>web.services2>
   Huomautus: ThewebKommentoimaton Services> -elementti on elementin aliweb>.

Lokitietojen määrittäminen Web Palvelujen API
Sinun on asetettava loki file polku- ja lokitasot. Lokitasot ovat kumulatiivisia. esimample, jos määrität tason 3, tasot 1, 2 ja 3 kirjataan lokiin. Oletuslokin taso on 8.

1. Muokkaa web palvelut Web.config. Oletussijainti on:
   APICP Web PalvelutWeb.config
2. Aseta lokiFilePolku. Oletusarvo on APIAPILogit. 3. Aseta LogLevel. Kelvolliset arvot ovat:
   0 = Ei kirjaamista
   1 = Lähdeobjekti ja -menetelmä
   2 = Virheilmoitus
   3 = Tuloparametrit
   4 = Palauttaa
   5 = Varoitus
   8 = tarkistuspiste

Virtuaalihakemiston todennuksen määrittäminen Web Palvelujen API
Sinun on otettava käyttöön anonyymi käyttö ja poistettava integroitu Windows-todennus käytöstä CP:lleWebPalvelun virtuaalinen hakemisto Internet Information Services (IIS) -palvelussa. Lisätietoja on Microsoft IIS -oppaissa.
Tietokannan yhteysasetusten määrittäminen Web Palvelujen API
Käytä Login Settings -apuohjelmaa tietokantayhteysasetusten salaamiseen Web Palvelujen API Web.config file. Lisätietoja saat etsimällä Changepointin asennusoppaasta hakusanalla ”Tietokannan yhteysasetusten määrittäminen”.
Todennuksen määrittäminen Changepoint WCF:lle Web Palvelut
Voit määrittää sovellustodennuksen ja kertakirjautumisen (SSO) Changepoint WCF:lle Web Palvelut.
Seuraavat toteutusvaihtoehdot ovat käytettävissä STS:n (Secure Token Service) avulla:

• SSO käyttäen ISAPI SSL:ää valinnainen
• SSO käyttäen WS-Federation (ADFS 2.0) SSL vaaditaan

Jos SSL vaaditaan, määritysskripti varmistaa, että sitä käytetään.
ISAPI:n ja sovellusten todennuksen määrityskomentosarjat voivat valinnaisesti ottaa käyttöön SSL:n.
Sovelluksen todennuksen määrittäminen WCF:lle Web Palvelut
Changepoint WCF:n oletustodennustyyppi Web Palvelut ovat sovellusten todennusta.
Käytä tämän osan menettelyjä:

• määritä Changepoint WCF Web Palvelut sovellusten todennuksen käyttämiseen SSL:n kanssa
• palauta Changepoint WCF Web Palvelut sovellusten todentamiseen sen jälkeen, kun jokin SSO-toteutuksista on otettu käyttöön

Määritä PowerShell

1. Avaa Windows PowerShell -kehote.
2. Muokkaa toteutuskäytäntöä:
   Set-ExecutionPolicy Rajoittamaton

Stage 1 Kerää konfigurointiparametrit
Määritä konfigurointiparametrien arvot.

Parametri	Kuvaus
WebPalvelupolku	Changepoint WCF:n sijainti Web Palvelut web sovellus files. Oletus: \API\CP Web Palvelut
Service Certificate_ Nimi	Sertifikaatin nimi, jota käytetään palvelun todentamiseen Viestin suojaustilaa käyttäville asiakkaille. Oletus: "CN=ChangepointAPICertificate" -varmenteen nimi.
vaativat HTTPS:n	Vaadi HTTPS (tosi/epätosi) Oletus: False.

Stage 2 Suorita määrityskomentosarjat
Käytä konfigurointiparametrien arvoja muuttaaksesi konfiguraatiota websivustoja.

1.  Avaa PowerShell-kehote.
   Huomautus: Jos palvelimessasi on käyttäjätilien valvonta käytössä, sinun on avattava PowerShell-kehote korotetuilla järjestelmänvalvojan käyttöoikeuksilla.
2. Navigoi CP:hen web palvelun määrityshakemisto, oletus:
   ConfigurationCPWebPalvelu
3.  Suorita ./Configuration_AppAuth.ps1
4. Noudata ohjeita.

Kertakirjautumisen (SSO) määrittäminen WCF:lle Web Palvelut
Määritä PowerShell

1. Avaa Windows PowerShell -kehote.
2. Muokkaa toteutuskäytäntöä:
   Set-ExecutionPolicy Rajoittamaton

SSO:n määrittäminen ISAPI:n avulla WCF:lle Web Palvelut
Stage 1 Kerää konfigurointiparametrit
Määritä seuraavien konfigurointiparametrien arvot.

Parametri	Kuvaus
WebPalvelupolku	Changepoint WCF:n sijainti Web Palvelut web sovellus files. Oletus: \API\CP Web Palvelut
vaativat HTTPS:n	Vaadi HTTPS (True/False). Oletus: False.
Muutospiste_RSA_ Cookie_Transform	Sen varmenteen nimi, jota käytät evästeiden salaukseen. Oletus: "CN=ChangepointAPICertificate" -varmenteen nimi.
ServiceCertificate_Name	Anna varmenteen nimi, jota käytetään palvelun todentamiseen Viestin suojaustilaa käyttäville asiakkaille. Oletus: "CN=ChangepointAPICertificate" -varmenteen nimi.
Allekirjoitussertifikaatin_nimi	Anna allekirjoitusvarmenteen nimi. Tämä on sen varmenteen nimi, jota käytät viestien allekirjoittamiseen. Oletus: "CN=ChangepointAPICertificate" -varmenteen nimi.
ISAPI_Mode	ISAPI-tila. Oletus: NT
ISAPI_Header	Otsikko, jota käytetään, kun ISAPI_Mode on "HEADER", esimample, tyhjä.
ClaimType	Anna SSO-vaatimuksen tyyppi. Oletus: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Suorita määrityskomentosarjat

1. Avaa PowerShell-kehote.
   Huomautus: Jos palvelimessasi on käyttäjätilien valvonta käytössä, sinun on avattava PowerShell-kehote korotetuilla järjestelmänvalvojan käyttöoikeuksilla.
2. Navigoi CP:hen web palvelun määrityshakemisto, oletus:
   ConfigurationCPWebPalvelu
3. Suorita: ./Configuration_SSO_ISAPI.ps1
4. Noudata ohjeita.

SSO:n määrittäminen WS-Federationin (ADFS 2.0) avulla WCF:lle Web Palvelut
Stage 1 Kerää konfigurointiparametrit
Määritä konfigurointiparametrien arvot alla olevasta taulukosta. Varmista, että ADFS_Server_URI on loppukäyttäjän selaimen intranet-vyöhykkeellä.
Huomautus: Oletusarvoisesti Changepoint on määritetty päivittämään automaattisesti julkiset avaimet, joita käytetään suojaustunnusten allekirjoittamiseen käyttämällä julkaistua liittämisen metatietoasiakirjaa. ADFS:ssä tämä on:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Joissakin tapauksissa ADFS-palvelimeen ei ehkä ole mahdollista päästä vaihtopisteestä web palvelin, joten sinun on päivitettävä asetukset manuaalisesti määrityskomentosarjan suorittamisen jälkeen. Katso lisätietoja kohdasta ”Julkisten avainten päivittäminen manuaalisesti” sivulla 12.

Parametri	Kuvaus
WebPalvelupolku	Changepoint WCF:n sijainti Web Palvelut web sovellus files. Oletus: \API\CP Web Palvelut
WebService_URI	Verkkotunnuksen tunniste, jota käytät Changepoint WCF:ssä Web Palvelut. esimample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Varmenteen nimi, jota käytät evästeiden salaukseen. Oletus: "CN=ChangepointApiCertificate" -varmenteen nimi.
ServiceCertificate_Name	Sertifikaatin nimi, jota käytetään palvelun todentamiseen Viestin suojaustilaa käyttäville asiakkaille. Oletus: "CN=ChangepointApiCertificate" -varmenteen nimi.
Allekirjoitussertifikaatin_nimi	Sen varmenteen nimi, jota käytät viestien allekirjoittamiseen. Oletus: "CN=ChangepointApiCertificate" -sertifikaatin nimeä käytetään.
ADFS_ FederationServiceName	Liittopalvelun nimi. Nimen saaminen: Käynnistä ADFS 2.0 -hallintakonsoli ADFS-palvelimesta. •Valitse ADFS 2.0 vasemmasta valikosta. • Valitse Toiminto-ruudusta Muokkaa liittämispalvelun ominaisuuksia. Liittämispalvelun nimi on Yleiset-välilehdellä.
ClaimType	SSO-vaatimuksen tyyppi. Oletus on: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Suorita määrityskomentosarjat
Määritä websivustot käyttävät määritysparametrien arvoja.

1. Avaa PowerShell-kehote.
   Huomautus: Jos palvelimessasi on käyttäjätilien valvonta käytössä, sinun on avattava PowerShell-kehote korotetuilla järjestelmänvalvojan käyttöoikeuksilla.
2. Navigoi muutospisteeseen web palvelun määrityshakemisto, oletus: ConfigurationCPWebPalvelu
3.  Suorita: ./Configuration_SSO_ADFS.ps1
4. Noudata ohjeita.

Stage 3 Luo luotettavan osapuolen luottamus
Luo Relying Party Trust ADFS 2.0 -konsolissa.

1. Käynnistä ADFS 2.0 -konsoli ADFS-palvelimellasi.
2. Valitse Toiminto > Lisää luottavainen osapuoli.
3. Napsauta Käynnistä.
4. Valitse Tuo luotettavan osapuolen tiedot, jotka on julkaistu verkossa tai paikallisessa verkossa.
5. Anna liittämisen metatietojen osoite ja napsauta sitten Seuraava, esimampseuraavat:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Anna näyttönimi, esim. Changepoint WCF API, ja napsauta Seuraava, Seuraava, Seuraava ja sitten Sulje.
7. Lisää vaatimussääntö yllä olevalle Changepointin luottavalle osapuolelle. Muutospisteen oletusvaatimussäännön nimi on "UPN".
8. Yhdistä LDAP-attribuutti "User-Principal-Name" lähtevän vaatimuksen tyyppiin "* UPN" tai "UPN".

Julkisten avainten manuaalinen päivittäminen
ADFS-palvelimen Token Signing Thumbprintin hankkiminen

1. Käynnistä ADFS 2.0 -hallintakonsoli ADFS-palvelimesta.
2. Valitse Palvelu > Sertifikaatit ja kaksoisnapsauta Token-allekirjoitusvarmennetta.
3. Valitse Tiedot-välilehti.
4. Valitse Thumbprint-kenttä.
5. Saat peukalonjäljen arvon poistamalla kaikki välilyönnit, mukaan lukien ensimmäinen välilyönti.

Päivittääksesi Web.config file

1. Muokkaa ADFS:ää web.config. Oletussijainti on:
   EnterpriseRP-STS_ADFS
2. Alla elementti, etsi ida:FederationMetadataLocation-avain ja tyhjennä sen arvo:
   
3. Alla , Etsi elementti ja korvaa se seuraavalla: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Testataan COM API -yhteyttä

1. Suorita API Test Kit. Oletussijainti on:
   APIAPI ComponentsApiTestKit.exe.
2. Napsauta Yhteysmerkkijono > Salaus.
3. Pelkkä teksti -yhteysmerkkijono -kentässä:
   a. Korvaa SERVERNAME ja DATABASENAME tietokantatiedoillasi.
   b. Korvaa USERID ja PASSWORD tietokannan järjestelmänvalvojan käyttäjätilitiedoilla.
   c. Syötä aikakatkaisun arvo tarvittaessa.
4. Napsauta Salaa.
5. Kopioi teksti Salattu yhteysmerkkijono -kenttään.
6. Sulje valintaikkuna.
7. Valitse API Test Kit -valikosta Yhteys > COM API Connection Tester.
8. Liitä Nykyinen versio -välilehden salattu yhteysmerkkijono Yhteysmerkkijono-kenttään.
9. Kirjoita LoginId- ja Password-kenttiin Changepoint-tilisi kirjautumistunnus ja salasana.
10. Määritä Lokitaso (0-8) -kentässä COM API -lokissa palautettavien virhetietojen taso file jos testitulos osoittaa yhteyden ongelman.
    0 = Ei kirjaamista
    1 = Lähdeobjekti ja -menetelmä
    2 = Virheilmoitus
    3 = Tuloparametrit
    4 = Palauttaa
    5 = Varoitus
    8 = tarkistuspiste
    Oletusarvo on 8.
11. Napsauta Yhdistä.
    Jos yhteys onnistui, Tulos-kentässä näkyy onnistumisviesti. Jos yhteys epäonnistui, tarkista COM API -loki file virheiden vuoksi. Lokin oletussijainti file On APIAPILogit.

Tarkistetaan asennettujen API-komponenttien versiota
Voit käyttää versiontarkistusapuohjelmaa saadaksesi tietoja asennetuista komponenteista, mukaan lukien julkaisuversion ja polun.

1. Suorita CPVersionChecker.exe. Oletuspolku on: APIAPI-komponentit
2. Napsauta Lue.

Tarkistetaan versiota Web Palvelujen API

1. Käynnistä Internet Explorer palvelimelta, jossa Web Services API on asennettu ja anna osoite:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  jossa portti on portin numero websivusto, johon asensit CP:nWebPalvelun virtuaalinen hakemisto.
2. Napsauta WSLogin-sivulla GetVersion-linkkiä.
3. Napsauta Kutsu.

Testaa Web Palvelujen API-yhteys

1. Käynnistä Internet Explorer palvelimelta, jossa Web Services API on asennettu ja anna osoite: http://localhost.port/CPWeb.Service/WSLogin.asmx  jossa portti on portin numero websivusto, johon asensit CP:nWebPalvelun virtuaalinen hakemisto.
2. Napsauta WSLogin-sivulla TestConnection-linkkiä.
3. Napsauta Kutsu. 4. Testituloksissa:

• Jos elementti on epätosi, testiyhteys onnistui.
• Jos elementti on tosi, testiyhteys epäonnistui. Lisää
  tietoja epäonnistumisen syistä, katso ja elementtejä testituloksissa ja tarkista API-lokit. Oletuspolku API-lokeihin on: APIAPILogit

Asetetaan Web Services API kielipalvelimella

1. Ota Changepoint käyttöön Web Services API kielipalvelimella, sinun on lisättävä tai päivitettävä tag in Web Palvelujen API web.config. Oletussijainti Web.config file On: APICP Web PalvelutWeb.config
2. Jos tag on jo olemassa, varmista, että sekä kulttuuri- että uiCulture-attribuutit ovat "en-US".
3. Jos tag ei ole jo olemassa, lisää seuraava , kommentoi ja elementtejäweb> solmu:web>
   Visual Basic -asetukset: Aseta strict=” true” estääksesi kaikki tietotyyppimuunnokset, joissa tietoja voi kadota. Aseta explicit=”true” pakottaaksesi kaikkien muuttujien ilmoittamisen. ->
4. Käynnistä IIS uudelleen.