¿Qué es una API exactamente?

• API significa Interfaz de Programación de Aplicaciones (Application Programming Interface). Es un mecanismo que permite que dos o más aplicaciones diferentes y no relacionadas "hablen" entre sí mediante el intercambio de 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 locales y basados en la nube, ya que los servicios web son comunes y están presentes en ambos entornos.

¿Cómo es 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 del internet regular, o mediante un método de conexión segura, como una VPN. En el caso de CommunityWFM, este servicio web es una parte integrada 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 y contraseña para prevenir el acceso no autorizado a los sistemas de CommunityWFM.

El uso de la API se realiza mediante una combinación de envío de datos (pushing) a CommunityWFM y extracción de datos (pulling) de CommunityWFM.

• "GET" = Extraer (pull)
• "POST" = Enviar (push)

La sintaxis para los comandos "GET" y "POST" puede ser específica para los datos en cuestión y se describe detalladamente en la documentación de la API de CommunityWFM.

Ejemplos de "GET"

Si desea 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 desea recuperar información resumida sobre el shrinkage considerado en un pronóstico, enviaría el siguiente comando "GET":

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

Ejemplos de "POST"

Si desea cambiar las asignaciones de actividad (trabajo) para un agente específico en CommunityWFM basándose en una fuente de datos externa, utilizaría el siguiente comando POST con la información pertinente:

“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 desea 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 tiempo libre pagado con sistemas de nómina o de gestión de personal 
  • Workday
  • ADP
• Sincronización de horas trabajadas/programadas con sistemas de nómina/tarjeta de tiempo, como Kronos.
• Carga de datos específicos de CommunityWFM en un data-mart para sistemas de informes personalizados.