Guía de instalación del software API de Changepoint

Guía de instalación de la API
Guía de referencia
Punto de cambio 2021

© 2021 Changepoint Canadá ULC Todos los derechos reservados. DERECHOS DEL GOBIERNO DE EE. UU.: el uso, la duplicación o la divulgación por parte del gobierno de EE. UU. están sujetos a las restricciones establecidas en el acuerdo de licencia ULC de Changepoint Canada y según lo dispuesto en DFARS 227.7202-1(a) y 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), según corresponda. Este producto contiene información confidencial y secretos comerciales de Changepoint Canada ULC. La divulgación está prohibida sin el permiso previo expreso por escrito de Changepoint Canada ULC. El uso de este producto está sujeto a los términos y condiciones del Acuerdo de licencia del usuario con Changepoint Canada ULC. La documentación solo puede ser reproducida por el Licenciatario para uso interno. El contenido de este documento no se puede alterar, modificar o cambiar sin el consentimiento expreso por escrito de Changepoint Canada ULC. Changepoint Canada ULC puede cambiar el contenido especificado en este documento en cualquier momento, con o sin previo aviso.

Instalación de la API de Changepoint

Acerca de la instalación de la API de Changepoint
La API de Changepoint está disponible como una API COM, un servicio de Windows Communication Foundation (WCF) y, por compatibilidad con versiones anteriores, como un Web Servicio de mejoras de servicios (WSE). Para obtener información sobre la API de Changepoint, consulte la referencia de la API de Changepoint. Para obtener notas de actualización, advertencias y problemas conocidos, consulte las notas de la versión en las carpetas del equipo en Changepoint.
Actualización de la API de Changepoint
Si está actualizando desde una versión anterior de Changepoint, utilice el Panel de control de Windows para desinstalar la versión anterior de la API de Changepoint y sus componentes antes de instalar esta versión.
Requisitos de la API de punto de cambio
Debe instalar Changepoint antes de instalar la API de Changepoint. Para conocer los requisitos de software, consulte la matriz de compatibilidad de software de Changepoint, que está disponible en la carpeta del equipo de parches y notas de la versión 2021 en Changepoint.
File convenciones de ruta
A lo largo de este documento, se utilizan las siguientes convenciones para rutas comunes:

• La ruta raíz de la instalación de Changepoint.
  La ruta predeterminada es:
  C:Program Files (x86)Punto de cambioPunto de cambio
• La ubicación raíz de las utilidades comunes de Changepoint, como la utilidad Configuración de inicio de sesión.
  La ruta predeterminada es:
  C:Program Files (x86) Común FilesPunto de cambioPunto de cambio

Instalación de la API de Changepoint

1. Desde el directorio raíz de medios de la API de Changepoint, ejecute setup.exe.
2. Siga las indicaciones hasta que aparezca la pantalla Seleccionar funciones.
3. Seleccione las funciones que desea instalar y haga clic en Siguiente.
4. Seleccione la carpeta de destino de la API, por defecto API y haga clic en Siguiente.
   Nota: La utilidad de configuración de inicio de sesión de Changepoint está instalada en LoginSettings, independientemente de la carpeta de destino que especifique.
5. Si seleccionó el Web API de servicios: a. Cuando la selección
   a Web Aparece la pantalla del sitio, seleccione un websitio para agregar el directorio virtual y luego haga clic en Siguiente.
   b. Presione siguiente para continuar. 6. Cuando se complete la instalación de la API, haga clic en Finalizar.

Configuración de la API de Changepoint para que tenga en cuenta la memoria caché
Para configurar la API de Changepoint para que reconozca la memoria caché, reemplace los valores de "cache. Contraseña” y “caché. Servidores” claves en el CP Web ServiciosWeb.configuración file con los valores utilizados en la empresaWeb.configuración file.
Habilitando Web Mejoras de servicios (WSE)

1. Editar el Web.configuración file para web servicios. La ubicación predeterminada es:
   APICP Web ServiciosWeb.configuración
2. Encuentre las tres instancias de la siguiente línea de comentario:
   < !– Descomente el siguiente elemento si está utilizando Web API de mejoras de servicio (WSE). Deje comentarios si usa servicios WCF y no está instalando Web Mejoras del servicio (WSE) –>
3. Descomente el elemento que sigue a cada instancia de la línea de comentario:
   <section name=”microsoft.web.servicios2″ … >webServicios>web.servicios2>
   Nota: ElwebServicios> El elemento que se va a descomentar es un elemento secundario deweb>.

Configuración del registro para el Web API de servicios
Debe configurar el registro file rutas y niveles de registro. Los niveles de registro son acumulativos. por ejemploample, si especifica el nivel 3, se registran los niveles 1, 2 y 3. El nivel de registro predeterminado es 8.

1. Editar el web servicios Web.config. La ubicación predeterminada es:
   APICP Web ServiciosWeb.configuración
2. Establecer el registroFileSendero. El valor predeterminado es Registros APIAPIL. 3. Establezca el nivel de registro. Los valores válidos son:
   0 = Sin registro
   1 = objeto de origen y método
   2 = mensaje de error
   3 = Parámetros de entrada
   4 = Devoluciones
   5 = Advertencia
   8 = Punto de control

Configuración de la autenticación de directorio virtual para el Web API de servicios
Debe habilitar el acceso anónimo y deshabilitar la autenticación integrada de Windows para el CPWebServicio de directorio virtual en Internet Information Services (IIS). Para obtener más información, consulte la documentación de Microsoft IIS.
Configuración de los ajustes de conexión de la base de datos para el Web API de servicios
Utilice la utilidad Configuración de inicio de sesión para cifrar la configuración de conexión de la base de datos en el Web API de servicios Web.configuración file. Para obtener más información, busque "Configuración de los ajustes de conexión de la base de datos" en la Guía de instalación de Changepoint.
Configuración de la autenticación para Changepoint WCF Web Servicios
Puede configurar la autenticación de aplicaciones y el inicio de sesión único (SSO) para Changepoint WCF Web Servicios.
Las siguientes opciones de implementación están disponibles mediante el Servicio de token seguro (STS):

• SSO usando ISAPI SSL opcional
• SSO usando WS-Federation (ADFS 2.0) Se requiere SSL

Si se requiere SSL, el script de configuración garantiza que se utilice.
Los scripts de configuración para ISAPI y la autenticación de aplicaciones pueden habilitar SSL opcionalmente.
Configuración de la autenticación de aplicaciones para WCF Web Servicios
El tipo de autenticación predeterminado para Changepoint WCF Web Servicios es autenticación de aplicaciones.
Utilice los procedimientos de esta sección para:

• configurar punto de cambio WCF Web Servicios para utilizar la autenticación de aplicaciones con SSL
• revertir punto de cambio WCF Web Servicios a la autenticación de aplicaciones después de haber implementado una de las implementaciones de SSO

Configurar PowerShell

1. Abra un indicador de Windows PowerShell.
2. Modificar la política de ejecución:
   Set-ExecutionPolicy Sin restricciones

Stage 1 Recoger parámetros de configuración
Determine los valores para los parámetros de configuración.

Parámetro	Descripción
Webruta_servicio	Ubicación del punto de cambio WCF Web Servicios web solicitud files. Defecto: \API\CP Web Servicios
Certificado de servicio_ Nombre	Nombre del certificado que se utilizará para autenticar el servicio a los clientes mediante el modo de seguridad de mensajes. Valor predeterminado: el nombre del certificado “CN=ChangepointAPICertificate”.
requieren HTTPS	Requerir HTTPS (Verdadero/Falso) Predeterminado: falso.

Stage 2 Ejecutar scripts de configuración
Utilice los valores de los parámetros de configuración para modificar la configuración del websitios.

1.  Abra un indicador de PowerShell.
   Nota: Si su servidor tiene habilitado el Control de cuentas de usuario, debe abrir el indicador de PowerShell con permisos de administrador elevados.
2. Navegar al CP web directorio de configuración del servicio, predeterminado:
   ConfiguraciónCPWebServicio
3.  Ejecute ./Configuration_AppAuth.ps1
4. Siga las indicaciones.

Configuración del inicio de sesión único (SSO) para WCF Web Servicios
Configurar PowerShell

1. Abra un indicador de Windows PowerShell.
2. Modificar la política de ejecución:
   Set-ExecutionPolicy Sin restricciones

Configuración de SSO mediante ISAPI para WCF Web Servicios
Stage 1 Recoger parámetros de configuración
Determine los valores para los siguientes parámetros de configuración.

Parámetro	Descripción
Webruta_servicio	La ubicación del WCF de Changepoint Web Servicios web solicitud files. Defecto: \API\CP Web Servicios
requieren HTTPS	Requerir HTTPS (Verdadero/Falso). Predeterminado: falso.
Punto de cambio_RSA_ Cookie_Transformar	El nombre del certificado que utiliza para el cifrado de cookies. Valor predeterminado: el nombre del certificado “CN=ChangepointAPICertificate”.
Nombre_certificado de servicio	Ingrese el nombre del certificado que se utilizará para autenticar el servicio a los clientes mediante el modo de seguridad de mensajes. Valor predeterminado: el nombre del certificado “CN=ChangepointAPICertificate”.
Nombre_certificado de firma	Introduzca el nombre del certificado de firma. Este es el nombre del certificado que utiliza para firmar mensajes. Valor predeterminado: el nombre del certificado “CN=ChangepointAPICertificate”.
Modo_ISAPI	El modo ISAPI. Predeterminado: NT
ISAPI_Encabezado	El encabezado utilizado cuando ISAPI_Mode es "HEADER", por ejemploample, en blanco.
Tipo de reclamación	Ingrese el tipo de reclamo de SSO. Por defecto: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ejecutar scripts de configuración

1. Abra un indicador de PowerShell.
   Nota: Si su servidor tiene habilitado el Control de cuentas de usuario, debe abrir el indicador de PowerShell con permisos de administrador elevados.
2. Navegar al CP web directorio de configuración del servicio, predeterminado:
   ConfiguraciónCPWebServicio
3. Ejecutar: ./Configuration_SSO_ISAPI.ps1
4. Siga las indicaciones.

Configuración de SSO mediante WS-Federation (ADFS 2.0) para WCF Web Servicios
Stage 1 Recoger parámetros de configuración
Determine los valores para los parámetros de configuración en la tabla a continuación. Asegúrese de que ADFS_Server_URI esté en la zona de Intranet del navegador del usuario final.
Nota: De forma predeterminada, Changepoint está configurado para actualizar automáticamente las claves públicas que se utilizan para firmar tokens de seguridad mediante el documento de metadatos de federación publicado. En ADFS esto es:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
En algunos casos, puede que no sea posible llegar al servidor ADFS desde el punto de cambio web servidor, por lo que tendrá que actualizar manualmente la configuración después de ejecutar el script de configuración. Para obtener más información, consulte “Actualización manual de claves públicas” en la página 12.

Parámetro	Descripción
Webruta_servicio	Ubicación del punto de cambio WCF Web Servicios web solicitud files. Defecto: \API\CP Web Servicios
WebServicio_URI	Identificador de dominio que usa para Changepoint WCF Web Servicios. por ejemploample., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_Cookie_Transform	Nombre del certificado que utiliza para el cifrado de cookies. Valor predeterminado: el nombre del certificado “CN=ChangepointApiCertificate”.
Nombre_certificado de servicio	Nombre del certificado que se utilizará para autenticar el servicio a los clientes mediante el modo de seguridad de mensajes. Valor predeterminado: el nombre del certificado “CN=ChangepointApiCertificate”.
Nombre_certificado de firma	Nombre del certificado que utiliza para firmar mensajes. Predeterminado: se utiliza el nombre de certificado “CN=ChangepointApiCertificate”.
ADFS_FederationServiceName	Nombre del servicio de federación. Para obtener el nombre: Desde el servidor de ADFS, inicie la consola de administración de ADFS 2.0. •Seleccione ADFS 2.0 en el menú de la izquierda. •Desde el panel Acción, seleccione Editar propiedades del servicio de federación. El nombre del servicio de federación se encuentra en la pestaña General.
Tipo de reclamación	Tipo de reclamación de SSO. El valor predeterminado es: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Ejecutar scripts de configuración
Configurar el websitios utilizando los valores de los parámetros de configuración.

1. Abra un indicador de PowerShell.
   Nota: Si su servidor tiene habilitado el Control de cuentas de usuario, debe abrir el indicador de PowerShell con permisos de administrador elevados.
2. Navegar al punto de cambio web directorio de configuración del servicio, predeterminado: ConfiguraciónCPWebServicio
3.  Ejecutar: ./Configuration_SSO_ADFS.ps1
4. Siga las indicaciones.

Stage 3 Crear confianza de usuario de confianza
Cree la relación de confianza para usuario autenticado en la consola de ADFS 2.0.

1. En su servidor ADFS, inicie la consola ADFS 2.0.
2. Seleccione Acción > Agregar confianza para usuario autenticado.
3. Haga clic en Iniciar.
4. Seleccione Importar datos sobre la parte de confianza publicados en línea o en una red local.
5. Ingrese la dirección de metadatos de la Federación y luego haga clic en Siguiente, por ej.ampen:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Ingrese un nombre para mostrar, por ejemplo, Changepoint WCF API, y haga clic en Siguiente, Siguiente, Siguiente y luego en Cerrar.
7. Agregue una regla de reclamo para la parte de confianza de Changepoint anterior. Para Changepoint, el nombre de regla de reclamación predeterminado es "UPN".
8. Asigne el atributo LDAP "User-Principal-Name" al tipo de notificación saliente "* UPN" o "UPN".

Actualización manual de claves públicas
Para obtener la huella digital de firma del token del servidor ADFS

1. Desde el servidor ADFS, inicie la consola de administración ADFS 2.0.
2. Seleccione Servicio > Certificados y haga doble clic en el certificado de firma de tokens.
3. Seleccione la pestaña Detalles.
4. Seleccione el campo Huella digital.
5. Para obtener el valor de la huella digital, elimine todos los espacios, incluido el primero.

Para actualizar el Web.configuración file

1. Editar el ADFS web.config. La ubicación predeterminada es:
   EmpresaRP-STS_ADFS
2. Bajo la encuentre la clave ida:FederationMetadataLocation y borre su valor:
   
3. Por debajo , encuentra el elemento y reemplácelo con lo siguiente: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Prueba de la conexión API COM

1. Ejecute el kit de prueba de API. La ubicación predeterminada es:
   Componentes APIAPIApiTestKit.exe.
2. Haga clic en Cadena de conexión > Encriptador.
3. En el campo Cadena de conexiones de texto sin formato:
   una. Reemplace SERVERNAME y DATABASENAME con la información de su base de datos.
   b. Reemplace USERID y PASSWORD con la información de su cuenta de usuario administrador de la base de datos.
   C. Introduzca el valor de tiempo de espera según sea necesario.
4. Haga clic en Cifrar.
5. En el campo Cadena de conexión cifrada, copie el texto.
6. Cerrar el cuadro de diálogo.
7. En el menú Kit de prueba de API, haga clic en Conexión > Probador de conexión API COM.
8. En la pestaña Versión actual, pegue la cadena de conexión cifrada en el campo Cadena de conexión.
9. En los campos LoginId y Password, ingrese el ID de inicio de sesión y la contraseña para su cuenta de Changepoint.
10. En el campo Loglevel (0-8), especifique el nivel de información de error que se devolverá en el registro de la API COM file si el resultado de la prueba muestra un problema con la conexión.
    0 = Sin registro
    1 = objeto de origen y método
    2 = mensaje de error
    3 = Parámetros de entrada
    4 = Devoluciones
    5 = Advertencia
    8 = Punto de control
    El valor predeterminado es 8.
11. Haga clic en Conectar.
    Si la conexión fue exitosa, se muestra un mensaje de éxito en el campo Resultado. Si la conexión falló, verifique el registro de la API COM file por errores La ubicación predeterminada del registro file es Registros APIAPIL.

Comprobación de la versión de los componentes de la API instalados
Puede utilizar la utilidad de comprobación de versiones para obtener detalles sobre los componentes instalados, incluida la versión de lanzamiento y la ruta.

1. Ejecute CPVersionChecker.exe. La ruta predeterminada es: Componentes APIAPI
2. Haga clic en Leer.

Comprobando la versión del Web API de servicios

1. Inicie Internet Explorer desde el servidor donde se encuentra el Web La API de servicios está instalada e ingresa la dirección:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  donde puerto es el número de puerto del websitio donde instaló el CPWebDirectorio virtual de servicios.
2. En la página WSLogin, haga clic en el enlace GetVersion.
3. Haga clic en Invocar.

Probando el Web Conexión API de servicios

1. Inicie Internet Explorer desde el servidor donde se encuentra el Web La API de servicios está instalada e ingresa la dirección: http://localhost.port/CPWeb.Service/WSLogin.asmx  donde puerto es el número de puerto del websitio donde instaló el CPWebDirectorio virtual de servicios.
2. En la página WSLogin, haga clic en el enlace TestConnection.
3. Haga clic en Invocar. 4. En los resultados de la prueba:

• Si elemento es falso, la conexión de prueba se realizó correctamente.
• Si elemento es verdadero, la conexión de prueba falló. Para más
  información sobre las razones del fallo, consulte el y elementos en los resultados de la prueba y verifique los registros de la API. La ruta predeterminada a los registros de la API es: APIAPIRegistros

Configuración del Web API de servicios en un servidor de idioma

1. Para implementar el punto de cambio Web API de servicios en un servidor de idioma, debe agregar o actualizar el tag en el Web API de servicios web.config. La ubicación predeterminada de la Web.configuración file es: APICP Web ServiciosWeb.configuración
2. Si el tag ya existe, asegúrese de que los atributos de cultura y uiCulture sean "en-US".
3. Si el tag aún no existe, agregue lo siguiente , comentar y elementos a laweb> nodo:web>
   Opciones de Visual Basic: Establezca strict=”true” para no permitir todas las conversiones de tipos de datos en las que se pueden producir pérdidas de datos. Establezca explicit="true" para forzar la declaración de todas las variables. –>
4. Reinicie IIS.