Ghid de instalare software API Changepoint

Ghid de instalare API
Ghid de referință
Punct de schimbare 2021

© 2021 Changepoint Canada ULC Toate drepturile rezervate. DREPTURILE GUVERNULUI SUA-Utilizarea, duplicarea sau dezvăluirea de către guvernul SUA este supusă restricțiilor stabilite în acordul de licență Changepoint Canada ULC și conform DFARS 227.7202-1(a) și 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19 sau FAR 52.227-14 (ALT III), după caz. Acest produs conține informații confidențiale și secrete comerciale ale Changepoint Canada ULC. Dezvăluirea este interzisă fără permisiunea prealabilă, expresă, scrisă a Changepoint Canada ULC. Utilizarea acestui produs se supune termenilor și condițiilor Acordului de licență al utilizatorului cu Changepoint Canada ULC. Documentația poate fi reprodusă de către titularul licenței numai pentru uz intern. Conținutul acestui document nu poate fi modificat, modificat sau modificat fără acordul expres scris al Changepoint Canada ULC. Changepoint Canada ULC poate modifica conținutul specificat aici în orice moment, cu sau fără notificare.

Instalarea API-ului Changepoint

Despre instalarea API-ului Changepoint
API-ul Changepoint este disponibil ca API COM, un serviciu Windows Communication Foundation (WCF) și, pentru compatibilitate cu versiunea anterioară, ca un Web Servicii de îmbunătățire a serviciilor (WSE). Pentru informații despre API-ul Changepoint, consultați Referința API-ului Changepoint. Pentru note de actualizare, avertismente și probleme cunoscute, consultați Notele de lansare din folderele echipei din Changepoint.
Actualizarea API-ului Changepoint
Dacă faceți upgrade de la o versiune anterioară a Changepoint, utilizați Panoul de control Windows pentru a dezinstala versiunea anterioară a API-ului Changepoint și componentele acesteia înainte de a instala această versiune.
Cerințe API Changepoint
Trebuie să instalați Changepoint înainte de a instala API-ul Changepoint. Pentru cerințele software, consultați Matricea de compatibilitate software Changepoint, care este disponibilă în folderul echipei Note de lansare și corecții 2021 din Changepoint.
File convențiile de cale
Pe parcursul acestui document, sunt utilizate următoarele convenții pentru căile comune:

• Calea rădăcină a instalării Changepoint.
  Calea implicită este:
  C:Program Files (x86)ChangepointChangepoint
• Locația rădăcină pentru utilitarele comune Changepoint, cum ar fi utilitarul Setări de conectare.
  Calea implicită este:
  C:Program Files (x86) Comun FilesChangepointChangepoint

Instalarea API-ului Changepoint

1. Din directorul rădăcină media Changepoint API, rulați setup.exe.
2. Urmați instrucțiunile până când apare ecranul Selectare caracteristici.
3. Selectați caracteristicile pe care doriți să le instalați, apoi faceți clic pe Următorul.
4. Selectați folderul de destinație API, implicit API și faceți clic pe Următorul.
   Nota: Utilitarul Changepoint Login Settings este instalat în LoginSettings, indiferent de folderul de destinație pe care îl specificați.
5. Dacă ați selectat Web Servicii API: a. Când selectați
   a Web Apare ecranul site-ului, selectați a website pentru a adăuga directorul virtual, apoi faceți clic pe Următorul.
   b. Faceți clic pe Următorul pentru a continua. 6. Când instalarea API-ului este finalizată, faceți clic pe Terminare.

Configurarea API-ului Changepoint pentru a fi conștient de cache
Pentru a configura API-ul Changepoint să fie conștient de cache, înlocuiți valorile pentru „cache. Parolă” și „cache. Servere” în CP Web ServiciiWeb.config file cu valorile utilizate în EnterpriseWeb.config file.
Activare Web Îmbunătățiri ale serviciilor (WSE)

1. Editați Web.config file pentru web Servicii. Locația implicită este:
   APICP Web ServiciiWeb.config
2. Găsiți cele trei cazuri ale următoarei linii de comentariu:
   < !– Decomentați următorul element dacă îl utilizați Web API-ul Service Enhances (WSE). Lăsați comentarii dacă utilizați serviciile WCF și nu instalați Web Îmbunătățiri ale serviciului (WSE) –>
3. Decomentați elementul care urmează fiecarei instanțe a liniei de comentariu:
   <section name=”microsoft.web.servicii2″ … >webServicii>web.servicii2>
   Nota: ThewebServicii> elementul care trebuie necomentat este un copil alweb>.

Configurarea înregistrării pentru Web Servicii API
Trebuie să setați jurnalul file niveluri de cale și jurnal. Nivelurile de jurnal sunt cumulate. De example, dacă specificați nivelul 3, atunci nivelurile 1, 2 și 3 sunt înregistrate. Nivelul implicit de jurnal este 8.

1. Editați web servicii Web.config. Locația implicită este:
   APICP Web ServiciiWeb.config
2. Setați jurnalulFileCale. Valoarea implicită este APIAPILogs. 3. Setați LogLevel. Valorile valide sunt:
   0 = Fără înregistrare
   1 = obiect și metodă sursă
   2 = Mesaj de eroare
   3 = Parametrii de intrare
   4 = Returnări
   5 = Avertisment
   8 = Punct de control

Configurarea autentificării directorului virtual pentru Web Servicii API
Trebuie să activați accesul anonim și să dezactivați autentificarea integrată Windows pentru CPWebDirector virtual de servicii în Internet Information Services (IIS). Pentru mai multe informații, consultați documentația Microsoft IIS.
Configurarea setărilor de conexiune la baza de date pentru Web Servicii API
Utilizați utilitarul Setări de conectare pentru a cripta setările de conexiune la baza de date în Web Servicii API Web.config file. Pentru mai multe informații, căutați „Configurarea setărilor de conexiune la baza de date” în Ghidul de instalare Changepoint.
Configurarea autentificării pentru Changepoint WCF Web Servicii
Puteți configura autentificarea aplicației și autentificarea unică (SSO) pentru Changepoint WCF Web Servicii.
Următoarele opțiuni de implementare sunt disponibile folosind Secure Token Service (STS):

• SSO folosind ISAPI SSL opțional
• Este necesar SSO folosind WS-Federation (ADFS 2.0).

Dacă este necesar SSL, scriptul de configurare asigură utilizarea acestuia.
Scripturile de configurare pentru ISAPI și autentificarea aplicației pot activa opțional SSL.
Se configurează autentificarea aplicației pentru WCF Web Servicii
Tipul de autentificare implicit pentru Changepoint WCF Web Serviciile sunt autentificarea aplicației.
Utilizați procedurile din această secțiune pentru a:

• configurați Changepoint WCF Web Servicii pentru a utiliza autentificarea aplicației cu SSL
• reveniți la Changepoint WCF Web Servicii pentru autentificarea aplicației după implementarea uneia dintre implementările SSO

Configurați PowerShell

1. Deschideți un prompt Windows PowerShell.
2. Modificați politica de execuție:
   Set-ExecutionPolicy Unrestricted

Stage 1 Colectați parametrii de configurare
Determinați valorile parametrilor de configurare.

Parametru	Descriere
WebCale_serviciu	Locația WCF Changepoint Web Servicii web aplicarea files. Mod implicit: \API\CP Web Servicii
ServiceCertificate_ Nume	Numele certificatului care va fi utilizat pentru autentificarea serviciului către clienți care utilizează modul de securitate Mesaj. Implicit: Numele certificatului „CN=ChangepointAPICertificate”.
necesită HTTPS	Necesită HTTPS (adevărat/fals) Implicit: fals.

Stage 2 Executați scripturi de configurare
Utilizați valorile parametrilor de configurare pentru a modifica configurația website-uri.

1.  Deschideți o solicitare PowerShell.
   Nota: Dacă serverul dvs. are activat Controlul contului de utilizator, trebuie să deschideți promptul PowerShell folosind permisiuni de administrator ridicate.
2. Navigați la CP web directorul de configurare a serviciului, implicit:
   ConfigurareCPWebServiciu
3.  Executați ./Configuration_AppAuth.ps1
4. Urmați instrucțiunile.

Configurarea autentificare unică (SSO) pentru WCF Web Servicii
Configurați PowerShell

1. Deschideți un prompt Windows PowerShell.
2. Modificați politica de execuție:
   Set-ExecutionPolicy Unrestricted

Configurarea SSO folosind ISAPI pentru WCF Web Servicii
Stage 1 Colectați parametrii de configurare
Determinați valorile pentru următorii parametri de configurare.

Parametru	Descriere
WebCale_serviciu	Locația WCF Changepoint Web Servicii web aplicarea files. Mod implicit: \API\CP Web Servicii
necesită HTTPS	Necesită HTTPS (adevărat/fals). Implicit: fals.
Punct de schimbare_RSA_ Cookie_Transform	Numele certificatului pe care îl utilizați pentru criptarea cookie-urilor. Implicit: Numele certificatului „CN=ChangepointAPICertificate”.
ServiceCertificate_Name	Introduceți numele certificatului care va fi utilizat pentru autentificarea serviciului clienților folosind modul de securitate Mesaj. Implicit: Numele certificatului „CN=ChangepointAPICertificate”.
Nume_certificat de semnare	Introduceți numele certificatului de semnare. Acesta este numele certificatului pe care îl utilizați pentru semnarea mesajelor. Implicit: Numele certificatului „CN=ChangepointAPICertificate”.
ISAPI_Mode	Modul ISAPI. Implicit: NT
ISAPI_Header	Antetul folosit când ISAPI_Mode este „HEADER”, de example, gol.
ClaimType	Introduceți tipul de revendicare SSO. Implicit: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Executați scripturi de configurare

1. Deschideți o solicitare PowerShell.
   Nota: Dacă serverul dvs. are activat Controlul contului de utilizator, trebuie să deschideți promptul PowerShell folosind permisiuni de administrator ridicate.
2. Navigați la CP web directorul de configurare a serviciului, implicit:
   ConfigurareCPWebServiciu
3. Executați: ./Configuration_SSO_ISAPI.ps1
4. Urmați instrucțiunile.

Configurarea SSO folosind WS-Federation (ADFS 2.0) pentru WCF Web Servicii
Stage 1 Colectați parametrii de configurare
Determinați valorile pentru parametrii de configurare din tabelul de mai jos. Asigurați-vă că ADFS_Server_URI se află în zona Intranet a browserului utilizatorului final.
Nota: În mod implicit, Changepoint este configurat să actualizeze automat cheile publice care sunt utilizate pentru a semna jetoane de securitate utilizând documentul de metadate ale federației publicat. În ADFS, acesta este:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
În unele cazuri, este posibil să nu fie posibil să ajungeți la serverul ADFS de la Changepoint web server, așa că va trebui să actualizați manual configurația după rularea scriptului de configurare. Pentru detalii, consultați „Actualizarea manuală a cheilor publice” la pagina 12.

Parametru	Descriere
WebCale_serviciu	Locația WCF Changepoint Web Servicii web aplicarea files. Mod implicit: \API\CP Web Servicii
WebService_URI	Identificatorul de domeniu pe care îl utilizați pentru Changepoint WCF Web Servicii. De example., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Numele certificatului pe care îl utilizați pentru criptarea cookie-urilor. Implicit: Numele certificatului „CN=ChangepointApiCertificate”.
ServiceCertificate_Name	Numele certificatului care va fi utilizat pentru autentificarea serviciului către clienți care utilizează modul de securitate Mesaj. Implicit: Numele certificatului „CN=ChangepointApiCertificate”.
Nume_certificat de semnare	Numele certificatului pe care îl utilizați pentru semnarea mesajelor. Implicit: este folosit numele certificatului „CN=ChangepointApiCertificate”.
ADFS_ FederationServiceName	Numele serviciului federației. Pentru a obține numele: de pe serverul ADFS, lansați consola de administrare ADFS 2.0. •Selectați ADFS 2.0 din meniul din stânga. •Din panoul Acțiune, selectați Editați proprietățile serviciului federativ. Numele serviciului federației se află în fila General.
ClaimType	Tip de revendicare SSO. Valoarea implicită este: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Executați scripturi de configurare
Configurați website-uri folosind valorile pentru parametrii de configurare.

1. Deschideți o solicitare PowerShell.
   Nota: Dacă serverul dvs. are activat Controlul contului de utilizator, trebuie să deschideți promptul PowerShell folosind permisiuni de administrator ridicate.
2. Navigați la punctul de schimbare web directorul de configurare a serviciului, implicit: ConfigurareCPWebServiciu
3.  Executați: ./Configuration_SSO_ADFS.ps1
4. Urmați instrucțiunile.

Stage 3 Creați încredere în partea de încredere
Creați încrederea părții de încredere în consola ADFS 2.0.

1. Pe serverul dvs. ADFS, lansați consola ADFS 2.0.
2. Selectați Acțiune > Adăugați încredere pentru partea de încredere.
3. Faceți clic pe Start.
4. Selectați Importați date despre partea de încredere publicate online sau într-o rețea locală.
5. Introduceți adresa metadatelor Federației, apoi faceți clic pe Următorul, de examppe:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Introduceți un nume afișat, de exemplu Changepoint WCF API și faceți clic pe Următorul, Următorul, Următorul, apoi Închideți.
7. Adăugați o regulă de revendicare pentru partea de încredere pentru punctul de modificare de mai sus. Pentru Changepoint, numele implicit al regulii de revendicare este „UPN”.
8. Mapați atributul LDAP „User-Principal-Name” la tipul de revendicare „* UPN” sau „UPN”.

Actualizarea manuală a cheilor publice
Pentru a obține amprenta de semnare a simbolului serverului ADFS

1. De pe serverul ADFS, lansați consola de administrare ADFS 2.0.
2. Selectați Serviciu > Certificate și faceți dublu clic pe certificatul de semnare a simbolurilor.
3. Selectați fila Detalii.
4. Selectați câmpul Amprentă.
5. Pentru a obține valoarea amprentei, eliminați toate spațiile, inclusiv primul spațiu.

Pentru a actualiza Web.config file

1. Editați ADFS web.config. Locația implicită este:
   EnterpriseRP-STS_ADFS
2. Sub element, găsiți cheia ida:FederationMetadataLocation și ștergeți valoarea acesteia:
   
3. Sub , găsi element și înlocuiți-l cu următorul: https://ADFS_Federation.ServiceName/adfs/services/trust„>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Testarea conexiunii COM API

1. Rulați kitul de testare API. Locația implicită este:
   APIAPI ComponentsApiTestKit.exe.
2. Faceți clic pe șir de conexiune > Encrypter.
3. În câmpul șir de conexiuni de text simplu:
   A. Înlocuiți SERVERNAME și DATABASENAME cu informațiile bazei de date.
   b. Înlocuiți ID-UL UTILIZATOR și PAROLA cu informațiile contului de utilizator de administrator al bazei de date.
   c. Introduceți valoarea timeout după cum este necesar.
4. Faceți clic pe Criptare.
5. În câmpul șir de conexiune criptată, copiați textul.
6. Închideți caseta de dialog.
7. În meniul API Test Kit, faceți clic pe Connection > COM API Connection Tester.
8. În fila Versiune curentă, inserați șirul de conexiune criptat în câmpul șirul de conexiune.
9. În câmpurile LoginId și Password, introduceți ID-ul de conectare și parola pentru contul dvs. Changepoint.
10. În câmpul Loglevel (0-8), specificați nivelul informațiilor despre eroare care trebuie returnate în jurnalul COM API file dacă rezultatul testului arată o problemă cu conexiunea.
    0 = Fără înregistrare
    1 = obiect și metodă sursă
    2 = Mesaj de eroare
    3 = Parametrii de intrare
    4 = Returnări
    5 = Avertisment
    8 = Punct de control
    Valoarea implicită este 8.
11. Faceți clic pe Conectare.
    Dacă conexiunea a avut succes, în câmpul Rezultat este afișat un mesaj de succes. Dacă conexiunea a eșuat, verificați jurnalul COM API file pentru erori. Locația implicită a jurnalului file este APIAPILogs.

Verificarea versiunii componentelor API instalate
Puteți utiliza utilitarul de verificare a versiunii pentru a obține detalii despre componentele instalate, inclusiv versiunea de lansare și calea.

1. Rulați CPVersionChecker.exe. Calea implicită este: Componente APIAPI
2. Faceți clic pe Citiți.

Verificarea versiunii de Web Servicii API

1. Lansați Internet Explorer de pe serverul unde este Web Services API este instalat și introduceți adresa:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  unde port este numărul portului al website-ul unde ați instalat CP-ulWebDirector virtual de servicii.
2. Pe pagina WSLogin, faceți clic pe linkul GetVersion.
3. Faceți clic pe Invocare.

Testarea Web Conexiune API pentru servicii

1. Lansați Internet Explorer de pe serverul unde este Web Services API este instalat și introduceți adresa: http://localhost.port/CPWeb.Service/WSLogin.asmx  unde port este numărul portului al website-ul unde ați instalat CP-ulWebDirector virtual de servicii.
2. Pe pagina WSLogin, faceți clic pe linkul TestConnection.
3. Faceți clic pe Invocare. 4. În rezultatele testului:

• Dacă elementul este fals, conexiunea de testare a reușit.
• Dacă elementul este adevărat, conexiunea de testare a eșuat. Pentru mai mult
  informații despre motivele eșecului, consultați și elemente din rezultatele testului și verificați jurnalele API. Calea implicită către jurnalele API este: APIAPILogs

Configurarea Web Servicii API pe un server de limbi

1. Pentru a implementa Changepoint Web Servicii API pe un server de limbă, trebuie să adăugați sau să actualizați tag în Web Servicii API web.config. Locația implicită a Web.config file este: APICP Web ServiciiWeb.config
2. Dacă tag există deja, asigurați-vă că atât cultura, cât și atributele uiCulture sunt „en-US”.
3. Dacă tag nu există deja, adăugați următoarele , comentează și elemente laweb> nod:web>
   Opțiuni Visual Basic: setați strict=" true" pentru a interzice toate conversiile tipurilor de date în care se poate produce pierderea de date. Setați explicit="true" pentru a forța declararea tuturor variabilelor. –>
4. Reporniți IIS.