Passer au contenu principal
Documentation
Documentation
Administrator Guide
Dernière mise à jour : 2026-03-13
Inscrire des agents externes

Inscrire des agents externes

Conditions préalables

Des étapes supplémentaires peuvent être nécessaires pour activer cette fonctionnalité en fonction du contrat service' abonnement de votre organisation. Votre organisation figure soit sur le Contrat-cadre de services (MSA), soit sur le Contrat-cadre de services universel (UMSA). Pour déterminer le contrat de service d'abonnement de votre organisation :
  1. Sélectionnez l'avatar de votre profil dans Workday Community .
  2. Sélectionnez
    Profil
     .
  3. Sur la page de votre profil, sélectionnez le nom de votre organisation, qui est sous votre nom et à côté de la désignation de l'emploi ().
  4. Affichez la valeur de votre
    accord d'abonnement
     .
Si sa valeur est égale à :
Des crédits variables sont obligatoire uniquement pour enregistrement et utiliser des agents dans vos environnements clients de production. Vous ne pourrez pas enregistrer et utiliser d'agents en production tant que vous n'avez pas accepté ces contrats. L'UMSA est obligatoire pour les environnements clients hors production et de production pour les agents Workday-Built. L'UMSA n'est pas obligatoire pour les environnements clients hors production pour les agents auto-configurés.
Définissez l'agent Système d'enregistrement .
Sécurité :
  • domaine
    Agent Management Hub
     dans le domaine fonctionnel Agent System of Record. Obligatoire pour vérifier que l'agent est enregistré dans Workday.
  • domaine
    Manage Agents
     dans le domaine fonctionnel Agent System of Record. Obligatoire pour l'activation et la configuration des aptitudes .
  • Domaine
    Set Up: Tenant Setup - Security
     dans le domaine fonctionnel System. Obligatoire pour l'inscription.

Contexte

Actuellement, vous pouvez uniquement enregistrer et définir des agents externes dans Workday à l'aide de l' API ASOR. Les agents externes sont définis et enregistrés simultanément à l'aide de l' API. Il ne s'agit pas de deux étapes distinctes. Vous pouvez utiliser n'importe quel client API de votre choix pour appeler l' API.
Reportez-vous à la documentation sur API ASOR v1.2 sur Github et l'exemple de documentation ASOR JSON Pour la résolution des problèmes.
Points de terminaison d'enregistrement :
  • REST API Endpoint:
     https://us.agent.workday.com/asor/v1/agentDefinition.
  • Token Endpoint:
     https://us.agent.workday.com/auth/oauth2/<Tenant_Name>/token
  • Point de terminaison autorisé :
     https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
Pour plus d'informations sur la disponibilité en dehors des États-Unis, reportez-vous à la documentation Agent Gateway :Référence : disponibilité de Agent Gateway dans certaines régions .

Options d'authentification :

Pour enregistrer des agents externes, vous avez besoin d'un jeton d'accès dans votre invocation de API ASOR. Vous trouverez ci-dessous les différentes options permettant d'obtenir un jeton pour appeler l'appel API ASOR.
Option 1 : authentifier manuellement un client API
  1. Accédez à la tâche
    Register API Client
     .
    • Nom du client :
       saisissez un nom unique pour identifier votre agent. Nous vous recommandons d'utiliser un client distinct pour chaque agent afin de faciliter leur gestion.
    • Client Grant Type:
      Authorization Code Grant
       .
    • Access Token Type:
      Career
       .
    • Redirection URI :
       saisissez une URL vers laquelle rediriger les utilisateurs après autorisation.
    • Périmètre (domaines fonctionnels) :
      Agent Système d'enregistrement
       .
    • Inclure un périmètre prédéfini par Workday :
       cochez cette case à cocher.
  2. Copiez et enregistrez les valeurs
    Identifiant client
     et
    Clé secrète client
     . Vous pouvez les utiliser pour obtenir un jeton d'accès afin d'appeler l' API de définition .
  3. Collez cette URL dans une nouvelle fenêtre. Cela devrait vous rediriger vers google.com avec un code ajouté que vous pouvez utiliser pour appeler l' API:
    https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
  4. Créer une nouvelle demande à l'aide d'un client API externe (par exemple, Duo) :
    https://<tenantHost>/ccx/oauth2/<tenantName>/ jeton
    • Corps :
      Grant_type=authorization_code&code=<authorizationCode>&client_id=<clientID>&client_secret=<ClientSecret>
    • Authentification : nom d'utilisateur =
      <ClientID>
       , mot de passe =
      <ClientSecret>
       .
    • Cela génère un jeton d'accès et un jeton actualiser que vous pouvez utiliser pour appeler l' API de définition de l'agent ASOR.
    • Pour cette étape, tenez compte des éléments suivants :Concept : éléments à prendre en compte avec l'agent ASU externe .
L'utilisateur enregistrement l'agent doit avoir accès au domaine Setup: Agents dans le domaine domaine fonctionnel Agent System of Record pour enregistrer un agent à l'aide de l' API ASOR.
Option 2 : s'authentifier avec Extend
Si vous êtes un utilisateur Workday Extend ou Workday Orchestrate, vous pouvez récupérer un jeton d'accès via le site de développement de Workday.
  1. Accédez à development.workday.com et connectez-vous.
  2. En haut à droite, cliquez sur le menu utilisateur. Le menu doit afficher le nom actuel de votre unité légale .
  3. Cliquez sur
    Environnement client
    Connexion à l'environnement client
    .
  4. Sélectionnez votre environnement et environnement client , puis cliquez sur
    Se connecter à l'environnement client
     .
  5. Connectez-vous à l' environnement client. Vous devez vous connecter avec un compte ayant accès au
    domaine Setup: Agents
     dans le domaine domaine fonctionnel Agent System of Record pour enregistrer un agent à l'aide de l' API ASOR.

Enregistrer un agent externe à l'aide de l' API ASOR

Prérequis :
  • jeton d'accès pour un compte ayant accès au domaine
    Setup: Agents
     dans le domaine fonctionnel Agent System of Record.
  • Un client API de votre choix.
  • Sécurité : domaines suivants dans le domaine fonctionnel System :
    • Custom Report Creation
    • Manage: All Custom Reports
    • Report Tag Management
Contexte :
Pour enregistrer un agent externe, vous devez :
  • Recherchez les identifiants Workday des API Workday (SOAP et REST) pertinentes que vous prévoyez d'inclure dans la définition des outils de votre agent en créant un rapport personnalisé.
  • Recherchez le fournisseur d'agents à l'aide de la tâche
    Afficher un fournisseur d'agents
     .
  • Appelez l' API REST ASOR
Recherche d'identifiants Workday SOAP et REST pour la définition d'outils de l'agent
  1. Accédez à la tâche
    Créer un rapport personnalisé
    .
  2. Pour créer le rapport, tenez compte des éléments suivants :
    Option
    Description
    Type de rapport
    Sélectionnez
    Avancé
    .
    Optimisé pour les performances
    Désélectionnez la case à cocher.
    Source de données
    Sélectionnez
    Public Web Services
     for SOAP et
    All Public Service Operations
     pour les API REST.
  3. Pour les API SOAP : sur la page
    Modifier un rapport personnalisé
     , dans l'onglet
    Colonnes
     de la définition du rapport, ajoutez les lignes suivantes :
    Objet de gestion
    Champ
    Service web
    Service web
    Opération du service web
    Nom de l'opération du service web
    Opération du service web
    Identifiant Workday
  4. Pour les API REST : sur la page
    Modifier un rapport personnalisé
     , dans l'onglet
    Colonnes
     de la définition du rapport, ajoutez les lignes suivantes :
    Objet de gestion
    Champ
    Opération de service
    Service
    Opération de service
    Nom
    Opération de service
    Identifiant Workday
  5. Enregistrez et exécutez le rapport.
Lorsque vous récupérez les identifiants Workday pour vos API, vous pouvez également faire référence aux listes suivantes :
Rechercher le fournisseur d'agents
Les fournisseurs d'agents font référence à la personne qui a conçu l'agent et qui sont affichés dans le champ
Création par du
 profil de l'agent.
  1. Accédez à la tâche
    View Agent Provider
     , sécurisé via le domaine
    Setup: Agents
     dans le domaine fonctionnel Agent System of Record .
  2. Utilisez le code de l'organisme dans votre appel API d'enregistrement de l'agent.
Rechercher la plateforme de l'agent
Les plateformes d'agents font référence à la plateforme ou au système externe sur lequel l'agent est développé et exécuté et qui sont affichées dans le champ
Création
 sur le profil de l'agent.
  1. Accédez à la tâche
    View Agent Platforms
     , sécurisé via le domaine Setup Agents dans le domaine fonctionnel Agent System of Record.
  2. Utilisez l'identifiant de la plateforme dans l'appel API d'enregistrement de l'agent.
Appelez l' API REST ASOR
Créez une nouvelle demande pour enregistrer votre agent à l'aide d'un client API externe, Exemple : Carlos.
Pour créer la demande, tenez compte des éléments suivants :

Hub Gestion des agents

Une fois que vous avez chargé votre définition d'agent dans Workday, vous pouvez vérifier qu'elle est enregistrée en l'affichant dans le
hub Gestion des agents
 .
  1. Accédez au rapport
    Hub Gestion des agents
     .
  2. Cliquez sur
    Registre de l'agent
     pour afficher la liste de vos agents.
  3. Cliquez sur un agent pour afficher ses informations d'aperçu.

Étapes suivantes

Configurez votre agent dans Workday.