Saltar al contenido

Configuración de la Autenticación de la API OData de SuccessFactors

SuccessFactors admite el flujo de afirmación de portador SAML de OAuth 2.0. Este flujo proporciona autorización restringida por el usuario, intercambiando aserciones SAML por tokens de acceso como se describe en la siguiente especificación:

https://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-23

Este documento cubre las siguientes tareas:

  1. Registre Vinyl como aplicación cliente SuccessFactors OAuth2
  2. Registre SuccessFactors como proveedor de seguridad de Vinyl.
  3. Registre el servidor de origen de datos del servicio SAP Servicio OData.

Requisitos

Para continuar, necesitará lo siguiente:

  • Una cuenta de SuccessFactors existente.
  • Acceso de administrador a la cuenta de SuccessFactors.
  • Acceso de administrador a Vinyl.

Registre Vinyl Como Aplicación Cliente SuccessFactors OAuth2

Vinyl deberá registrarse en SuccessFactors como una aplicación cliente de OAuth2. Para registrar Vinyl como aplicación cliente OAuth2, necesitará la siguiente información:

Ejemplo Notas
Nombre de la aplicación Vinyl El nombre de la aplicación es arbitrario. Si registra varias instancias de Vinyl como aplicaciones cliente OAuth2, asigne a cada una un nombre distintivo.
URL de la aplicación https://example.com/Vinyl/ Esta es la raíz web de Vinyl. La URL debe incluir la barra diagonal.
Nombre común ejemplo.com Esta es la parte del nombre de alojar de la raíz web.

Para registrar Vinyl como aplicación cliente SuccessFactors OAuth2:

  1. Inicie sesión en SuccessFactors como administrador
  2. Navegue hasta el Centro de administración
  3. Seleccione Configuración de la empresa → Administrar aplicaciones cliente OAuth 2
  4. Haga clic en el botón Registrar aplicación de cliente
  5. Proporcione el Nombre de la aplicación y la URL de la aplicación.
  6. Haga clic en el botón Generar certificado X.509
  7. Proporcione el Nombre común (CN)
  8. Haga clic en el botón Generar
  9. Haga clic en el botón Descargar para guardar el certificado.
  10. Haga clic en el botón Registrarse

Una vez registrado, SuccessFactors le asignará una clave API. La clave API, junto con el certificado, será necesaria para completar los procedimientos restantes.

Convertir Certificado

SuccessFactors genera un certificado con formato PEM; El Vinyl requiere un certificado con formato PKCS#12 codificado en base64. Una discusión completa de este tema está fuera del alcance de este documento. Sin embargo, a modo de ejemplo, se puede utilizar la utilidad de línea de comandos OpenSSL para convertir un certificado de PEM a PKCS#12:

openssl pkcs12 -in certificate.pem -export -out certificate.pfx

Tenga en cuenta que se le pedirá que proporcione una contraseña. Registre la contraseña, ya que la necesitará más adelante.

Para codificar en base64 el certificado:

openssl base64 -in certificate.pfx -out certificate.txt -A

Para obtener información adicional sobre los certificados de la aplicación cliente SuccessFactors OAuth2, consulte el siguiente documento:

http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf

Nota

Al momento de escribir este artículo, SuccessFactors no genera un certificado compatible con OpenSSL. Para que el certificado sea compatible, abra el certificado en un editor de texto y realice los siguientes cambios:

Reemplace ambas apariciones de "CLAVE PRIVADA CIFRADA" con "CLAVE PRIVADA".

Inserte saltos de línea de modo que ninguna línea tenga más de 76 caracteres. Tenga en cuenta que estos deben ser saltos de línea de estilo Unix (salto de línea), no saltos de línea de estilo Windows o Internet (pares de salto de línea/retorno de carro).

Registre SuccessFactors Como Proveedor de Seguridad de Vinyl

Para registrar SuccessFactors como proveedor de seguridad de Vinyl, necesitará la siguiente información:

Ejemplo Notas
Clave API SuccessFactors asigna la clave API al registrar la aplicación cliente OAuth2 (ver arriba).
Certificado de firma El certificado de firma debe ser un certificado PKCS#12 codificado en base64 que contenga la clave privada. El certificado se puede generar manualmente o durante el proceso de registro de la aplicación cliente SuccessFactors OAuth2 (ver arriba).
Contraseña del certificado de firma La contraseña del certificado de firma se asigna al generar el certificado con formato PKCS#12.
ID de empresa El identificador de la empresa SuccessFactors.
URL de API de instancia https://api8.successfactors.com/ URL de la API de SuccessFactors: " Las URLs de sus extremo para acceder a las APIs de OData dependen del centro de datos que aloja su instancia de SuccessFactors". Consulte http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf para informacion adicional.

Nota

La URL no contiene la ruta /odata/v2. El Vinyl agregará el camino.

Para registrar SuccessFactors como proveedor de seguridad de Vinyl:

  1. Inicie sesión en Vinyl como administrador
  2. Navegue hasta IDE
  3. Haga clic en el botón Proveedores de seguridad
  4. Desde el panel Autenticación de origen de datos, haga clic en el botón + Autenticación de origen de datos

  5. Proporcione lo siguiente:

    • Nombre: un nombre de proveedor de seguridad único.
    • Ejemplo: SuccessFactors
    • Tipo: SuccessFactors OData

    • Prioridad: un número entero único entre 10 y 100. Tenga en cuenta que este valor debe ser único.

      Ejemplo: 40

  6. Haga clic en el botón Guardar

  7. Establezca las siguientes propiedades (en el panel Propiedades, haga clic en el botón + Propiedad → Seleccione el Parámetro → Proporcione el Valor → Haga clic en el icono Guardar):

    • Tipo de autenticación: Saml
    • ID de empresa: ID de empresa
    • ApiKey: *Clave API *
    • InstanceApiUrl: * URL de API de instancia *
    • Certificado de firma: Certificado de firma
    • Contraseña del certificado de firma: Contraseña del certificado de firma

  8. Haga clic en el botón Editar en el panel Proveedores.

  9. Marque la opción Habilitado
  10. Haga clic en el botón Guardar

Registre el Servidor de Origen de Datos del Servicio SAP Servicio OData

Para registrar SuccessFactors como servidor de fuente de datos de Vinyl, necesitará la siguiente información:

Ejemplo Notas
Extremo de OData https://api8.successfactors.com/odata/v2/ URL de la API de SuccessFactors: " Las URLs de sus extremo para acceder a las APIs de OData dependen del centro de datos que aloja su instancia de SuccessFactors". Consulte http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf para informacion adicional.
Nombre del proveedor de seguridad Factores de Éxito El nombre del proveedor de seguridad proporcionado anteriormente.

Nota

A partir de marzo de 2016, el Extremo de OData parece requerir una barra diagonal.

Para registrar SuccessFactors como servidor de origen de datos de Vinyl:

  1. Inicie sesión en Vinyl como administrador
  2. Navegue hasta IDE
  3. Seleccione el botón Servidores de datos
  4. En el panel Servidores de datos, haga clic en el botón + Servidor

  5. Proporcione lo siguiente:

    • Nombre: un nombre de servidor lógico y único.
    • Ejemplo: SuccessFactors
    • Tipo: Factores de Éxito

    • URL: {OData Endpoint}

      Example: https://api8.successfactors.com/odata/v2

    • Ejemplo: https://api8.successfactors.com/odata/v2

    • Proveedor de seguridad: {Security Provider Name}

  6. Haga clic en el botón Guardar

Una vez que se haya registrado el servidor de origen de datos, haga clic en el botón Probar conexión para asegurarse de que todo esté configurado correctamente. Es posible que se le solicite que inicie sesión con Okta en este momento.

Solución de Problemas

Una lista de respuestas de error de SuccessFactors OAuth 2.0 está disponible en la siguiente página:

http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf

El siguiente apéndice "Mensajes de error relacionados con OAuth 2.0" contiene errores adicionales:

http://help.sap.com/saphelpiis_cloud4hr/EN/SF_HCMS_OData_API_User_en/2ff9b29c3b774ebdaf367526a5444072.html

Consulte lo siguiente para obtener información adicional sobre solución de problemas:

Proveedor de seguridad: SuccessFactors OData

"O el servidor no está disponible o la información de conexión es incorrecta". al probar la conexión

Asegúrese de que la URL del servidor de origen de datos termine con una barra diagonal. Por ejemplo:

https://api8.successfactors.com/odata/v2/

A partir de marzo de 2016, SuccessFactors requiere una barra diagonal.

"Está prohibido acceder a la API de OData mediante autenticación básica o OAuth externo en servidores que no sean API ". al probar la conexión

Es posible que el extremo de la API haya sido reemplazado por un nuevo extremo. Por ejemplo, se han reemplazado los siguientes extremos:

  • En noviembre de 2015, el extremo API https://salesdemo4.successfactors.com/ fue reemplazado con https://apisalesdemo4.successfactors.com/.
  • En marzo de 2016, el extremo API https://hcm8preview.sapsf.com/ fue reemplazado con https://api8preview.sapsf.com/.