
Guia d'instal·lació de l'API
Guia de referència
Punt de canvi 2021
© 2021 Changepoint Canada ULC Tots els drets reservats. DRETS DEL GOVERN dels EUA: l'ús, la duplicació o la divulgació per part del govern dels EUA estan subjectes a les restriccions que s'estableixen a l'acord de llicència ULC de Changepoint Canada i tal com s'estableix a 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 o FAR 52.227-14 (ALT III), segons correspongui. Aquest producte conté informació confidencial i secrets comercials de Changepoint Canada ULC. La divulgació està prohibida sense el permís previ i exprés per escrit de Changepoint Canada ULC. L'ús d'aquest producte està subjecte als termes i condicions de l'Acord de llicència de l'usuari amb Changepoint Canada ULC. La documentació només pot ser reproduïda pel Llicenciatari per a ús intern. El contingut d'aquest document no es pot alterar, modificar o canviar sense el consentiment exprés per escrit de Changepoint Canada ULC. Changepoint Canada ULC pot canviar el contingut especificat aquí en qualsevol moment, amb o sense avís.
Instal·lació de l'API de Changepoint
Sobre la instal·lació de l'API de Changepoint
L'API de Changepoint està disponible com a API COM, un servei de Windows Communication Foundation (WCF) i, per compatibilitat amb versions anteriors, com a Web Servei de millores de serveis (WSE). Per obtenir informació sobre l'API de Changepoint, consulteu la Referència de l'API de Changepoint. Per obtenir notes d'actualització, advertències i problemes coneguts, consulteu les Notes de la versió a les carpetes d'equip a Changepoint.
Actualització de l'API de Changepoint
Si esteu actualitzant des d'una versió anterior de Changepoint, utilitzeu el tauler de control de Windows per desinstal·lar la versió anterior de l'API de Changepoint i els seus components abans d'instal·lar aquesta versió.
Requisits de l'API Changepoint
Heu d'instal·lar Changepoint abans d'instal·lar l'API de Changepoint. Per obtenir informació sobre els requisits de programari, consulteu la Matriu de compatibilitat de programari de Changepoint, que està disponible a la carpeta de l'equip Notes i pegats de la versió de 2021 a Changepoint.
File convencions de camí
Al llarg d'aquest document, s'utilitzen les convencions següents per als camins comuns:
- La ruta arrel de la instal·lació de Changepoint.
El camí per defecte és:
C: Programa Files (x86)ChangepointChangepoint - La ubicació arrel de les utilitats comunes de Changepoint, com ara la utilitat de configuració d'inici de sessió.
El camí per defecte és:
C: Programa Files (x86) Comú FilesChangepointChangepoint
Instal·lació de l'API de Changepoint
- Des del directori arrel dels mitjans de l'API de Changepoint, executeu setup.exe.
- Seguiu les instruccions fins que aparegui la pantalla Selecciona les funcions.
- Seleccioneu les funcions que voleu instal·lar i feu clic a Següent.
- Seleccioneu la carpeta de destinació de l'API, per defecte API i feu clic a Següent.
Nota: La utilitat Changepoint Login Settings està instal·lada a LoginSettings, independentment de la carpeta de destinació que especifiqueu. - Si heu seleccionat el Web API de serveis: a. Quan seleccioneu
a Web Apareix la pantalla del lloc, seleccioneu a weblloc on afegir el directori virtual i, a continuació, feu clic a Següent.
b. Feu clic a Següent per continuar. 6. Quan s'hagi completat la instal·lació de l'API, feu clic a Finalitzar.
Configuració de l'API de Changepoint perquè tingui en compte la memòria cau
Per configurar l'API de Changepoint perquè tingui en compte la memòria cau, substituïu els valors per a "cache. Contrasenya" i "cache. "Servidors" al CP Web ServeisWeb.config file amb els valors utilitzats a l'empresaWeb.config file.
Habilitant Web Millores de serveis (WSE)
- Edita el Web.config file per web serveis. La ubicació per defecte és:
APICP Web ServeisWeb.config - Cerqueu les tres instàncies de la línia de comentari següent:
< !– Descomenteu l'element següent si feu servir Web API de millores del servei (WSE). Deixeu comentaris si feu servir serveis WCF i no s'està instal·lant Web Millores del servei (WSE) –> - Descomenteu l'element que segueix cada instància de la línia de comentari:
<section name=”microsoft.web.serveis2″ … >webServeis>web.serveis2>
Nota: ElwebServeis> l'element que no s'ha de comentar és un fill delweb>.
Configuració del registre per a Web API de serveis
Heu de configurar el registre file nivells de ruta i registre. Els nivells de registre són acumulatius. Per exampsi especifiqueu el nivell 3, es registren els nivells 1, 2 i 3. El nivell de registre predeterminat és 8.
- Edita el web serveis Web.config. La ubicació per defecte és:
APICP Web ServeisWeb.config - Estableix el registreFileCamí. El valor predeterminat és APIAPILogs. 3. Definiu el LogLevel. Els valors vàlids són:
0 = Sense registre
1 = Objecte i mètode font
2 = Missatge d'error
3 = Paràmetres d'entrada
4 = Retorns
5 = Avís
8 = Punt de control
Configuració de l'autenticació del directori virtual per a Web API de serveis
Heu d'habilitar l'accés anònim i desactivar l'autenticació integrada de Windows per al CPWebDirectori virtual de serveis a Internet Information Services (IIS). Per obtenir més informació, consulteu la documentació de Microsoft IIS.
Configuració de la configuració de connexió de la base de dades per al Web API de serveis
Utilitzeu la utilitat Configuració d'inici de sessió per xifrar la configuració de connexió de la base de dades a Web API de serveis Web.config file. Per obtenir més informació, cerqueu "Configuració dels paràmetres de connexió de la base de dades" a la Guia d'instal·lació de Changepoint.
Configuració de l'autenticació per a Changepoint WCF Web Serveis
Podeu configurar l'autenticació d'aplicacions i l'inici de sessió únic (SSO) per a Changepoint WCF Web Serveis.
Les opcions d'implementació següents estan disponibles mitjançant Secure Token Service (STS):
- SSO mitjançant ISAPI SSL opcional
- SSO obligatori mitjançant WS-Federation (ADFS 2.0) SSL
Si es requereix SSL, l'script de configuració assegura que s'utilitza.
Els scripts de configuració per a ISAPI i l'autenticació d'aplicacions poden habilitar SSL opcionalment.
Configuració de l'autenticació de l'aplicació per a WCF Web Serveis
El tipus d'autenticació predeterminat per a Changepoint WCF Web Serveis és l'autenticació d'aplicacions.
Utilitzeu els procediments d'aquesta secció per:
- configurar Changepoint WCF Web Serveis per utilitzar l'autenticació d'aplicacions amb SSL
- revertir el punt de canvi WCF Web Serveis per a l'autenticació de l'aplicació després d'haver implementat una de les implementacions SSO
Configura PowerShell
- Obriu un indicador de Windows PowerShell.
- Modifiqueu la política d'execució:
Set-ExecutionPolicy sense restriccions
Stage 1 Recolliu els paràmetres de configuració
Determineu els valors dels paràmetres de configuració.
| Paràmetre | Descripció |
| WebService_Path | Ubicació del WCF de Changepoint Web Serveis web aplicació files. Per defecte: \API\CP Web Serveis |
| Certificat de servei_ Nom |
Nom del certificat que s'utilitzarà per autenticar el servei als clients mitjançant el mode de seguretat de missatges. Per defecte: el nom del certificat "CN=ChangepointAPICertificate". |
| requereix HTTPS | Requereix HTTPS (vertader/fals) Per defecte: fals. |
Stage 2 Executar scripts de configuració
Utilitzeu els valors dels paràmetres de configuració per modificar la configuració del fitxer webllocs.
- Obriu un indicador de PowerShell.
Nota: Si el vostre servidor té el control de comptes d'usuari habilitat, heu d'obrir el missatge de PowerShell amb permisos d'administrador elevats. - Navegueu fins al CP web directori de configuració del servei, per defecte:
ConfiguracióCPWebServei - Executeu ./Configuration_AppAuth.ps1
- Seguiu les indicacions.
Configuració de l'inici de sessió únic (SSO) per a WCF Web Serveis
Configura PowerShell
- Obriu un indicador de Windows PowerShell.
- Modifiqueu la política d'execució:
Set-ExecutionPolicy sense restriccions
Configuració d'SSO mitjançant ISAPI per a WCF Web Serveis
Stage 1 Recolliu els paràmetres de configuració
Determineu els valors dels paràmetres de configuració següents.
| Paràmetre | Descripció |
| WebService_Path | La ubicació del WCF de Changepoint Web Serveis web aplicació files. Per defecte: \API\CP Web Serveis |
| requereix HTTPS | Requereix HTTPS (vertader/fals). Per defecte: fals. |
| Canvi de punt_RSA_ Cookie_Transform |
El nom del certificat que utilitzeu per al xifratge de galetes. Per defecte: el nom del certificat "CN=ChangepointAPICertificate". |
| Nom_Certificat de servei | Introduïu el nom del certificat que s'utilitzarà per autenticar el servei als clients mitjançant el mode de seguretat de missatges. Per defecte: el nom del certificat "CN=ChangepointAPICertificate". |
| SigningCertificate_Name | Introduïu el nom del certificat de signatura. Aquest és el nom del certificat que utilitzeu per signar missatges. Per defecte: el nom del certificat "CN=ChangepointAPICertificate". |
| Mode_ISAPI | El mode ISAPI. Per defecte: NT |
| ISAPI_Header | La capçalera que s'utilitza quan ISAPI_Mode és "HEADER", per exempleample, en blanc. |
| ClaimType | Introduïu el tipus de reclamació SSO. Per defecte: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Executar scripts de configuració
- Obriu un indicador de PowerShell.
Nota: Si el vostre servidor té el control de comptes d'usuari habilitat, heu d'obrir el missatge de PowerShell amb permisos d'administrador elevats. - Navegueu fins al CP web directori de configuració del servei, per defecte:
ConfiguracióCPWebServei - Executeu: ./Configuration_SSO_ISAPI.ps1
- Seguiu les indicacions.
Configuració de SSO mitjançant WS-Federation (ADFS 2.0) per a WCF Web Serveis
Stage 1 Recolliu els paràmetres de configuració
Determineu els valors dels paràmetres de configuració a la taula següent. Assegureu-vos que ADFS_Server_URI es troba a la zona d'Intranet del navegador de l'usuari final.
Nota: De manera predeterminada, Changepoint està configurat per actualitzar automàticament les claus públiques que s'utilitzen per signar testimonis de seguretat mitjançant el document de metadades de la federació publicat. A ADFS això és:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
En alguns casos, és possible que no sigui possible arribar al servidor ADFS des del punt de canvi web servidor, de manera que haureu d'actualitzar manualment la configuració després d'executar l'script de configuració. Per obtenir més informació, vegeu “Actualització manual de les claus públiques” a la pàgina 12.
| Paràmetre | Descripció |
| WebService_Path | Ubicació del WCF de Changepoint Web Serveis web aplicació files. Per defecte: \API\CP Web Serveis |
| WebServei_URI | Identificador de domini que utilitzeu per a Changepoint WCF Web Serveis. Per exampel., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_ Cookie_Transform | Nom del certificat que utilitzeu per al xifratge de galetes. Per defecte: el nom del certificat "CN=ChangepointApiCertificate". |
| Nom_Certificat de servei | Nom del certificat que s'utilitzarà per autenticar el servei als clients mitjançant el mode de seguretat de missatges. Per defecte: el nom del certificat "CN=ChangepointApiCertificate". |
| SigningCertificate_Name | Nom del certificat que utilitzeu per signar missatges. Per defecte: s'utilitza el nom del certificat "CN=ChangepointApiCertificate". |
| ADFS_ FederationServiceName | Nom del servei de la federació. Per obtenir el nom: Des del servidor ADFS, inicieu la consola de gestió ADFS 2.0. •Seleccioneu ADFS 2.0 al menú de l'esquerra. •Des del panell Acció, seleccioneu Edita les propietats del servei de federació. El nom del servei de la federació es troba a la pestanya General. |
| ClaimType | Tipus de reclamació SSO. El valor predeterminat és: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Executar scripts de configuració
Configura el webllocs utilitzant els valors dels paràmetres de configuració.
- Obriu un indicador de PowerShell.
Nota: Si el vostre servidor té el control de comptes d'usuari habilitat, heu d'obrir el missatge de PowerShell amb permisos d'administrador elevats. - Navegueu fins al punt de canvi web directori de configuració del servei, per defecte: ConfiguracióCPWebServei
- Executeu: ./Configuration_SSO_ADFS.ps1
- Seguiu les indicacions.
Stage 3 Crear confiança de la part de confiança
Creeu la confiança de la part de confiança a la consola ADFS 2.0.
- Al vostre servidor ADFS, inicieu la consola ADFS 2.0.
- Seleccioneu Acció > Afegeix confiança de la part de confiança.
- Feu clic a Inici.
- Seleccioneu Importa dades sobre la part de confiança publicades en línia o en una xarxa local.
- Introduïu l'adreça de metadades de la Federació i, a continuació, feu clic a Següent, per exempleampLI:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Introduïu un nom de visualització, per exemple, l'API Changepoint WCF, i feu clic a Següent, Següent, Següent i, a continuació, Tanca.
- Afegiu una regla de reclamació per a la part de confiança del punt de canvi anterior. Per al punt de canvi, el nom predeterminat de la regla de reclamació és "UPN".
- Assigna l'atribut LDAP "Nom-principal d'usuari" al tipus de reclamació de sortida "* UPN" o "UPN".
Actualització manual de claus públiques
Per obtenir l'empremta digital de signatura del testimoni del servidor ADFS
- Des del servidor ADFS, inicieu la consola de gestió ADFS 2.0.
- Seleccioneu Servei > Certificats i feu doble clic al certificat de signatura de testimoni.
- Seleccioneu la pestanya Detalls.
- Seleccioneu el camp Empremta digital.
- Per obtenir el valor de l'empremta digital, traieu tots els espais inclòs el primer.
Per actualitzar el Web.config file
- Editeu l'ADFS web.config. La ubicació per defecte és:
EnterpriseRP-STS_ADFS - Sota el element, cerqueu la clau ida:FederationMetadataLocation i esborreu el seu valor:
- Sota , troba el element i substituïu-lo pel següent: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />
Prova la connexió de l'API COM
- Executeu el kit de prova de l'API. La ubicació per defecte és:
Components APIAPIApiTestKit.exe. - Feu clic a Cadena de connexió > Encriptador.
- Al camp Cadena de connexions de text sense format:
a. Substituïu SERVERNAME i DATABASENAME per la informació de la vostra base de dades.
b. Substituïu l'USUARI i la CONTRAsenya per la informació del vostre compte d'usuari administrador de la base de dades.
c. Introduïu el valor del temps d'espera segons calgui. - Feu clic a Encriptar.
- Al camp Cadena de connexió xifrada, copieu el text.
- Tanqueu el quadre de diàleg.
- Al menú API Test Kit, feu clic a Connection > COM API Connection Tester.
- A la pestanya Versió actual, enganxeu la cadena de connexió xifrada al camp Cadena de connexió.
- Als camps LoginId i Password, introduïu l'identificador d'inici de sessió i la contrasenya del vostre compte de Changepoint.
- Al camp Nivell de registre (0-8), especifiqueu el nivell d'informació d'error que es retornarà al registre de l'API COM file si el resultat de la prova mostra un problema amb la connexió.
0 = Sense registre
1 = Objecte i mètode font
2 = Missatge d'error
3 = Paràmetres d'entrada
4 = Retorns
5 = Avís
8 = Punt de control
El valor predeterminat és 8. - Feu clic a Connecta.
Si la connexió ha tingut èxit, es mostra un missatge d'èxit al camp Resultat. Si la connexió ha fallat, comproveu el registre de l'API COM file per errors. La ubicació predeterminada del registre file és APIAPILogs.
Comprovació de la versió dels components de l'API instal·lats
Podeu utilitzar la utilitat de verificació de versions per obtenir detalls sobre els components instal·lats, inclosa la versió i el camí de la versió.
- Executeu CPVersionChecker.exe. El camí per defecte és: Components APIAPI
- Feu clic a Llegir.
Comprovant la versió del Web API de serveis
- Inicieu Internet Explorer des del servidor on es troba Web S'ha instal·lat l'API de serveis i introduïu l'adreça:
http://localhost.port/CPWeb.Service/WSLogin.asmx on port és el número de port del weblloc on heu instal·lat el CPWebDirectori virtual de serveis. - A la pàgina WSLogin, feu clic a l'enllaç GetVersion.
- Feu clic a Invocar.
Prova el Web Connexió de l'API de serveis
- Inicieu Internet Explorer des del servidor on es troba Web S'ha instal·lat l'API de serveis i introduïu l'adreça: http://localhost.port/CPWeb.Service/WSLogin.asmx on port és el número de port del weblloc on heu instal·lat el CPWebDirectori virtual de serveis.
- A la pàgina WSLogin, feu clic a l'enllaç TestConnection.
- Feu clic a Invocar. 4. En els resultats de la prova:
- Si element és fals, la connexió de prova ha estat correcta.
- Si element és cert, la connexió de prova ha fallat. Per a més
informació sobre els motius de la fallada, vegeu el i elements als resultats de la prova i comproveu els registres de l'API. El camí predeterminat als registres de l'API és: APIAPILogs
Configuració del Web API de serveis en un servidor d'idiomes
- Per desplegar el punt de canvi Web API de serveis en un servidor d'idiomes, heu d'afegir o actualitzar el tag en el Web API de serveis web.config. La ubicació predeterminada del Web.config file és: APICP Web ServeisWeb.config
- Si el tag ja existeix, assegureu-vos que tant els atributs cultura com uiCulture siguin "en-US".
- Si el tag encara no existeix, afegiu el següent , comenta i elements a laweb> node:web>
Opcions de Visual Basic: defineix strict="true" per no permetre totes les conversions de tipus de dades on es puguin perdre dades. Estableix explicit="true" per forçar la declaració de totes les variables. –> - Reinicieu IIS.
Documents/Recursos
![]() |
Programari API Changepoint [pdfGuia d'instal·lació API, programari, programari API |




