Qu'est-ce qu'une API de toute façon?

• API signifie Interface de Programmation d'Applications. C'est un mécanisme qui permet à deux ou plusieurs applications différentes et non liées de "communiquer" entre elles en partageant des données.
• L'API CommunityWFM appartient à la catégorie des API connues sous le nom de "RESTful".
• Une API RESTful permet à deux systèmes de partager des données via un service web accessible, évitant ainsi la nécessité pour les deux systèmes d'être directement connectés. Cela permet une connectivité sécurisée et facile entre toute combinaison de systèmes basés sur site et basés sur le cloud, car les services web sont courants et présents dans les deux environnements.

À quoi ressemble une API?

Un "Service Web" est simplement une URL qui réside sur le serveur d'application web d'un système et est accessible via Internet régulier, ou une méthode de connexion sécurisée, telle qu'un VPN. Dans le cas de CommunityWFM, ce service web est une partie incluse du serveur IIS de l'environnement.

Comment fonctionne l'API?

Tout d'abord, l'interface s'authentifie avec le service web de l'API CommunityWFM avec une combinaison sécurisée de nom d'utilisateur/mot de passe pour empêcher tout accès non autorisé aux systèmes CommunityWFM.

L'utilisation de l'API se fait par une combinaison de poussée de données dans CommunityWFM et d'extraction de données de CommunityWFM.

• “GET” = Extraction
• “POST” = Poussée

La syntaxe des commandes “GET” et “POST” peut être spécifique aux données en question et est entièrement décrite dans la documentation de l'API CommunityWFM.

Exemples de "GET"

Si je veux récupérer une liste d'agents actuellement connectés via CommunityWFM, j'enverrais la commande “GET” suivante au service web de l'API CommunityWFM :

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

Si je veux récupérer des informations sommaires sur la réduction prise en compte dans une prévision, j'enverrais la commande “GET” suivante :

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

Exemples de "POST"

Si je veux changer les affectations d'activité (travail) pour un agent spécifique dans CommunityWFM basé sur une source de données externe, j'utiliserais la commande POST suivante avec les informations pertinentes :

“POST api/ActivityAgentAssignment” otransactionFlagId – insérer/mettre à jour/supprimer/etc. oagentId – Agent en cours de modification. oassignedActivities – Activités modifiées pour cet agent. oresponsibleAgentId – Utilisateur du système qui initie/autorise le changement.

Si je veux insérer un événement planifié dans l'horaire d'un agent via une source externe, j'utiliserais la commande POST suivante avec certains paramètres, tels que :

“POST api/ScheduleEvent” oeventId – Quel est l'événement ajouté/modifié/supprimé ? oagentId – Quel agent est affecté ? oduration – Combien de temps l'événement durera-t-il ? oeventDate – À quelle date le changement d'événement aura-t-il lieu ?

Cas d'utilisation réels pour l'API CommunityWFM

• L'application mobile CommunityWFM (iOS, Android)
• Synchronisation des soldes de PTO avec les systèmes RH
  • Workday
  • ADP
• Synchronisation des heures travaillées/programmé avec les systèmes de paie/cartes de temps, tels que Kronos.
• Alimentation des données spécifiques à CommunityWFM dans un data-mart pour les systèmes de rapports personnalisés.