¿Qué es una API de todos modos?

• API significa Interfaz de Programación de Aplicaciones. Es un mecanismo que permite que dos o más aplicaciones diferentes y no relacionadas "hablen" entre sí compartiendo datos.
• La API de CommunityWFM pertenece a la categoría de APIs conocidas como "RESTful".
• Una API RESTful permite que dos sistemas compartan datos a través de un servicio web accesible, evitando así la necesidad de que ambos sistemas estén conectados directamente. Esto permite una conectividad segura y fácil entre cualquier combinación de sistemas basados en premisas y sistemas basados en la nube, ya que los servicios web son comunes y están presentes en ambos entornos.

¿Cómo se ve una API?

Un "Servicio Web" es simplemente una URL que reside en el servidor de aplicaciones web de un sistema y es accesible a través de internet regular, o un método de conexión segura, como una VPN. En el caso de CommunityWFM, este servicio web es una parte incluida del servidor IIS del entorno.

¿Cómo funciona la API?

Primero, la interfaz se autentica con el Servicio Web de la API de CommunityWFM con una combinación segura de nombre de usuario/contraseña para prevenir el acceso no autorizado a los sistemas de CommunityWFM.

El uso de la API es a través de una combinación de enviar datos a CommunityWFM y extraer datos de CommunityWFM.

• "GET" = Extraer
• "POST" = Enviar

La sintaxis para los comandos "GET" y "POST" puede ser específica para los datos en cuestión y está completamente descrita en la documentación de la API de CommunityWFM.

Ejemplos de "GET"

Si quiero recuperar una lista de agentes que están actualmente conectados a través de CommunityWFM, enviaría el siguiente comando "GET" al Servicio Web de la API de CommunityWFM:

"GET api/AgentLogonReport?sortOption={sortOption}&showLoggedOnOnly={showLoggedOnOnly}&nameFilter={nameFilter}&userId={userId}"

Si quiero recuperar información resumida sobre la reducción considerada en un pronóstico, enviaría el siguiente comando "GET":

“GET api/ForecastShrinkageSummary?forecastId={forecastId}&revisionNumber={revisionNumber}”

"POST" Ejemplos

Si quiero cambiar las asignaciones de Actividad (trabajo) para un agente específico en CommunityWFM basado en una fuente de datos externa, usaría el siguiente comando POST con la información relevante:

“POST api/ActivityAgentAssignment” otransactionFlagId – insertar/actualizar/eliminar/etc. oagentId – Agente que está siendo modificado. oassignedActivities – Actividades que están siendo modificadas para dicho agente. oresponsibleAgentId – Usuario del sistema que está iniciando/autorizando el cambio.

Si quiero insertar un evento programado en el horario de un agente a través de una fuente externa, usaría el siguiente comando POST con ciertos parámetros, tales como:

“POST api/ScheduleEvent” oeventId – ¿Cuál es el evento que se está agregando/modificando/eliminando? oagentId – ¿Qué agente está afectado? oduration – ¿Cuánto tiempo durará el evento? oeventDate – ¿En qué fecha ocurrirá el cambio del evento?

Casos de uso del mundo real para la API de CommunityWFM

• La aplicación móvil de CommunityWFM (iOS, Android)
• Sincronización de saldos de PTO con sistemas de recursos humanos
  • Workday
  • ADP
• Sincronización de horas trabajadas/programadas con sistemas de nómina/tarjeta de tiempo, como Kronos.
• Alimentación de datos específicos de CommunityWFM en un data-mart para sistemas de informes personalizados.