Descripción de la API de OData y el Centro de API

API significa Application Programming Interface (interfaz de programación de aplicaciones). API es un conjunto de métodos de comunicación claramente definidos entre varios componentes de software. Esta comunicación es útil para transferir información entre SAP SuccessFactors y otros sistemas de terceros.

Las API están en tendencia hacia recursos web de estilo Representational State Transfer (REST) más directos. La transferencia de estado representacional (REST) o servicios web RESTful es una forma de proporcionar interoperabilidad entre sistemas informáticos en Internet. Los servicios web compatibles con REST permiten solicitar a los sistemas acceder y manipular representaciones textuales de recursos web mediante el uso de un conjunto uniforme y predefinido de operaciones sin estado.

El siguiente tema se centra en las API REST y su comunicación a través de OData.

OData (Open Data Protocol) es un estándar OASIS que define las prácticas recomendadas para crear y consumir APIs RESTful. OData le ayuda a centrarse en su lógica empresarial al crear API RESTful sin tener que preocuparse por los enfoques para definir cabeceras de solicitud y respuesta, códigos de estado, convenciones de URL, tipos de medios, formatos de payload, opciones de consulta, etc. OData también le guía sobre el seguimiento de modificaciones, la definición de funciones y acciones para procedimientos reutilizables y el envío de solicitudes por lotes asincrónicas, etc.

OData proporciona tanto un estándar para representar sus datos como un método de metadatos para describir la estructura de sus datos y las operaciones disponibles en su API.

Un protocolo basado en estándares facilita el soporte de API y aumenta la adopción por las siguientes consideraciones:

• OData es un estándar de SAP.

• Las potentes funciones de consulta extraen datos de varias entidades (piense en SQL JOINS).

• Los datos se pueden devolver en estructuras de datos anidadas, con la selección de formatos XML o JSON.

• Estos estándares son críticos para la extensibilidad de HANA Cloud.

• Dado que OData se considera un estándar de la industria, los clientes no tienen que aprender las funciones patentadas de SFAPI, como SFQL y nuestros metadatos personalizados.

Con la API de OData, puede:

1. Consulta para extraer datos del sistema.
2. Cree (inserte) datos nuevos en el sistema.
3. Actualizar datos existentes en el sistema.
4. Borrar datos del sistema.
5. Operar en varias entidades relacionadas en una sola operación.

Es importante tener en cuenta que la operación de metadatos le permite ver el esquema de datos:

• ¿Cuáles son las entidades en la configuración de un cliente?

• ¿Cuáles son las relaciones entre estas entidades?

• ¿Cuáles son los campos y los tipos de datos de estas entidades?

• ¿Qué otras funciones de metadatos se utilizan, como etiquetas de campo, comportamientos de campo, etc.?

Todas las entidades de MDF se exponen automáticamente a través de las API de OData. Al utilizar las API de OData de MDF, los usuarios pueden acceder a las entidades de MDF, crearlas, insertarlas y eliminarlas. Los usuarios administradores también pueden crear y gestionar definiciones de objetos de MDF y listas desplegables a través de las API de OData de MDF. Además, las API de OData de MDF se utilizan para integrarse con sistemas de terceros.

Para obtener información adicional, como etiquetas de idioma, listas desplegables, etc., más allá de lo que proporcionan los metadatos OData estándar, OData de SAP SuccessFactors expone los metadatos como una entidad.

La API de OData de SAP SuccessFactors expone una entidad denominada Entidad. Sus propiedades se exponen como valor de tipo complejo incrustado en el cuerpo de respuesta de la entidad. Se pueden exponer diferentes formas de metadatos sin cambiar el formato de metadatos OData estándar.

Puede acceder a los nuevos metadatos al igual que accede a una entidad normal. Además, admite un filtro simple para emitir metadatos de una entidad específica o un grupo de entidades.

Además de la información que puede obtener del diccionario de la API de OData sobre una entidad, los metadatos le proporcionan información sobre las entidades asociadas con la entidad, listas desplegables, relaciones entre la entidad y otras entidades, etc.

El Centro de API es una ventanilla única para acceder al Registro de auditoría de la API de OData y al Diccionario de la API de OData.

Encontrará el Centro de API en la búsqueda Acción. Si no puede verlo allí, compruebe que tiene la autorización Acceso al Centro de API (disponible en la categoría Gestionar herramientas de integración en RBP).

Desde el Centro de API, puede acceder a las siguientes acciones:

• Lista de elementos autorizados de la API de OData: para configurar la lista de elementos autorizados de IP cuando se utiliza la autenticación básica. Se admiten tanto IPv4 como IPv6.
• Gestionar opciones de API de usuario: De forma similar a las opciones de Importación de empleados, permite establecer acciones opcionales que se producen cuando se realiza la operación de escritura del usuario, como
  • Seleccione el nuevo formato de contraseña predeterminada de usuario.
  • Enviar correo electrónico de bienvenida a los nuevos usuarios.
  • Validar campos de Gerente y RR. HH.
  • Procesar empleados inactivos.
  • Especifique las opciones de envío de formularios, como Transferencia automática de supervisor o Eliminación automática de documento.
  .
• Gestión de metadatos de la API de OData: navega a la herramienta Actualización y exportación de metadatos de la API de OData para actualizar la caché o exportar metadatos a un archivo XML
• Configuración de registro de auditoría: establezca la API de OData y la configuración de registro de auditoría de SFAPI. Los registros de auditoría de la API incluyen información de solicitud y respuesta de la API, incluidos los payloads. Esta información ayuda a los desarrolladores a diagnosticar los problemas que se han producido durante una llamada a la API y a ver y descargar el historial de transacciones de la API para la resolución de problemas de la API
• Registro de auditoría de la API de OData. Permite visualizar los logs de auditoría para las transacciones de API, incluido el estado, la entidad o la llamada de la API de OData.
• Diccionario de datos de la API de OData. Contiene todas las entidades disponibles en su instancia. Enumera las operaciones permitidas, el campo (nombre de propiedad), la etiqueta y qué campos son obligatorios o no.
• Configuración de OAuth para OData: para gestionar y registrar aplicaciones de cliente OAuth2 para poder autenticar usuarios de API mediante OAuth2. Después de registrar una aplicación, obtendrá una clave API exclusiva para que su aplicación acceda a las API de OData de SAP SuccessFactors.

El registro de auditoría de OData puede ayudar con problemas de soporte y depuración relacionados con el uso de OData. La herramienta Integración de log de auditoría supervisa el tráfico y obtiene información de payload detallada sobre las solicitudes de API realizadas en su sistema.

Otras consideraciones incluyen:

• El log de auditoría de OData captura detalles de payload para las últimas 10.000 llamadas de OData. Este log le permite inspeccionar las solicitudes de payload OData exactas realizadas al sistema y las respuestas OData correspondientes enviadas por el sistema.

• La herramienta es para desarrolladores que utilizan OData durante una implementación o administradores que desean compartir información en este log con el soporte de la solución SAP SuccessFactors HCM para ayudar a resolver problemas relacionados con OData.

• Puede descargar datos de llamadas individuales y enviarlos a un representante del servicio de asistencia de para su análisis.

• Herramienta de actualización y exportación de metadatos de la API de OData

Dentro de la herramienta Actualización y exportación de metadatos de la API de OData, verá los siguientes botones:

• Actualizar: actualiza la caché de metadatos. Los metadatos actualizados se regeneran y se guardan en la caché y están disponibles para operaciones futuras, como la exportación.

• Exportar: exporta y descarga los metadatos. El nombre del archivo de exportación predeterminado es CompanyName-Metadata.xml.

Algunas de las conclusiones clave de esta lección son:

• API o interfaz de programación de aplicaciones, es un conjunto de métodos de comunicación entre componentes de software para enviar información entre SAP SuccessFactors y otros sistemas.

• OData o Open Data Protocol le ayuda a centrarse en su lógica empresarial al crear API REST (transferencia de estado representacional).

• La API de OData utiliza para consultar para extraer datos del sistema, crear y actualizar nuevos datos o eliminar datos, así como para operar en varias entidades relacionadas en una sola operación.

• Con la herramienta Centro de API, los administradores pueden acceder al diccionario de API de OData, con todas las entidades disponibles en la instancia, así como otras acciones, como la configuración del registro de auditoría, Gestionar opciones de API de usuario o Lista de elementos autorizados de la API de OData.