Configurations pour utiliser Workday l’API REST

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 6 minutes de lecture

    • Configurez votre ServiceNow instance pour effectuer des actions qui utilisent l’API Workday REST.

    Avant de commencer

    • Demandez un Centre d'intégration abonnement.
    • Activez le Workday RH spoke.
    • Accédez à ces valeurs depuis Workday et enregistrez-les pour une utilisation ultérieure. Ces valeurs sont nécessaires pour enregistrer votre client :
      • ID client
      • Secret client
      • Workday Point de terminaison REST API
      • Point de terminaison de jeton
      • Point de terminaison d’autorisation
    • Rôle requis : admin

    Pourquoi et quand exécuter cette tâche

    Workday REST et l’API RAAS (Report-as-a-Service) fonctionnent avec OAuth 2.0 pour autoriser l’accès aux ressources de votre Workday locataire. Pour utiliser OAuth 2.0, vous devez enregistrer votre client dans le locataire, à l’aide de la tâche Enregistrer le client de l’API.

    Configurez votre ServiceNow instance pour utiliser l’API REST si vous devez utiliser ces Workday actions de spoke basées sur REST :
    • Obtenir la structure de mon reporting
    • Rechercher les champs personnalisés de l’objet
    • Mettre à jour les champs personnalisés de l’objet
    • Rechercher un bulletin de paie
    • Rechercher les rémunérations globales à l’aide de Rapport
    • Rechercher des rapports personnalisés
    • Rechercher des éléments dans la boîte de réception
    • Rechercher les détails du plan au mérite et du régime de prestations d’un employé.
    • Rechercher le WID de référence des calendriers des congés d’un employé
    • Rechercher le WID de référence de planification des calendriers d’un employé
    • Rechercher les calendriers des congés d’un employé
    • Rechercher à l’aide d’un flux WQL
    Remarque :
    Ces configurations sont nécessaires pour utiliser les actions de spoke basées sur REST.

    Enregistrer Workday RH en tant que fournisseur OAuth

    Enregistrez l’instance Workday RH en tant que fournisseur OAuth afin que l’instance ServiceNow puisse demander des jetons OAuth 2.0.

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Accédez à la Tous > OAuth système > Registre d'application.
    2. Cliquez sur Nouveau.
      Le système affiche ce message : Quel type d’application OAuth ?.
    3. Sélectionnez Se connecter à un fournisseur OAuth tiers.
    4. Renseignez ces valeurs sur le formulaire.
      Tableau 1. Formulaire des registres d'application
      Champ Description
      Nom Nom permettant d'identifier l'enregistrement de façon unique. Par exemple, entrez : OAuth RH Workday
      Application Application dans laquelle l’enregistrement s’applique. Sélectionnez le spoke Workday RH.
      ID client ID client généré lors de l’inscription de votre client.
      Secret client Secret client généré lors de l’enregistrement de votre client.
      URL d'autorisation Point de terminaison d’autorisation généré lors de l’enregistrement de votre client.
      URL de jeton Point de terminaison de jeton généré lors de l’inscription de votre client.
      URL de redirection Point de terminaison de rappel OAuth au format suivant : https://<instance>.service-now.com/oauth_redirect.do
      Type d'accord par défaut Type d'accord utilisé pour établir le jeton. Sélectionnez Code d'autorisation.
      Actives Option permettant d’utiliser activement le registre d’application.
    5. Cliquez avec le bouton droit de la souris sur l'en-tête du formulaire, puis cliquez sur Enregistrer.
      Un profil d’entité OAuth est créé.

    Générer l’URL du jeton pour le spoke Workday RH

    Enregistrez le client API dans votre compte Workday et générez une URL de jeton pour le spoke Workday RH.

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Connectez-vous à votre locataire Workday.
    2. Accédez à Rechercher et saisissez la tâche Enregistrer le client API .
    3. Renseignez les champs dans Enregistrer le client API.
      Champ Description
      Nom du client Nom du client de l’application. Par exemple, le spoke Workday RH.
      Type d’attribution client Sélectionnez Attribution du code d’autorisation.
      Type de jeton d’accès Type de jeton d’accès : Sélectionner un porteur
      Redirection URI Saisissez votre URL ServiceNow au format suivant : https://<instance>.service-now.com/oauth_redirect.do.
      Jetons d’actualisation sans expiration Option permettant d’activer les jetons d’actualisation qui n’expirent pas.
      Périmètre (domaines fonctionnels) Sélectionnez les domaines fonctionnels requis.
      Inclure le périmètre détenu par Workday Option permettant de sélectionner un périmètre appartenant à Workday.
    4. Cliquez sur OK.

    Résultats

    Copiez et stockez la valeur du point de terminaison du jeton généré pour configurer la propriété système.

    Option 1 : configuration de l’utilisation de l’API Workday REST RH avec un modèle

    Configurez votre ServiceNow instance pour effectuer les actions qui utilisent l’API REST à l’aide Workday RH d’un modèle d’autorisation OAuth.

    Avant de commencer

    Rôle requis : admin

    Configurer une connexion pour l’API REST Workday RH

    Ajoutez et configurez une connexion API REST Workday RH pour authentifier les demandes ServiceNow dans le spoke Workday RH.

    Avant de commencer

    Procédure

    1. Accédez à la Tous > Automatisation des processus > Studio de workflow.
    2. Sélectionnez Intégrations.
    3. Sélectionnez l’onglet Connexions .
    4. Utilisez la zone de recherche pour trouver l’alias de connexion WorkdayHR .
    5. Cliquez sur Afficher les détails.
      Modèle de connexion pour le spoke Workday RH
    6. Configurez une connexion dans le cloud.
      1. Ajoutez ou modifiez une connexion au cloud.
        • Pour configurer une connexion existante, sélectionnez Configurer ou Modifier.Configurer la connexion à l’aide du modèle de connexion pour le spoke Workday RH
        • Pour créer et configurer une connexion, sélectionnez Ajouter une connexion.
      2. Renseignez les champs du formulaire de configuration.
      Tableau 2. Formulaire de configuration
      Champ Description
      Nom Nom permettant d’identifier la connexion de façon unique. Par exemple, la connexion du spoke Workday RH.
      URL de connexion URL permettant d’établir une connexion avec Workday RH. Utilisez ce format : https://<workday_host>/ccx/service/<tenant_name>
      Nom de locataire Nom du locataire Workday. Par exemple, bcone_gms1.
      Version de l'API Version de l’API Workday à utiliser pour les demandes.
      ID client ID client généré dans Workday pour l’authentification OAuth.
      Secret client Secret client généré dans Workday pour l’authentification OAuth.
      URL d'autorisation URL utilisée pour autoriser la connexion OAuth. Utiliser ce format : https://<workday_host>/autoriser
      URL de jeton URL utilisée pour générer le jeton OAuth. Utiliser le format suivant : https://<workday_host>/jeton
      URL de redirection OAuth URL vers laquelle Workday redirige après une authentification réussie. Utiliser ce format : https://<instance_name>.service-now.com/oauth_redirect.do
    7. Cliquez sur Enregistrer et obtenir le jeton OAuth.

    Résultats

    La connexion de spoke est configurée et prête à être utilisée.

    Option 2 : configuration pour utiliser Workday REST API RH sans modèle

    Configurez votre ServiceNow instance pour effectuer des actions qui utilisent l’API Workday RH REST en créant manuellement des enregistrements de connexion et d’informations d’identification.

    Avant de commencer

    Rôle requis : admin

    Créer un enregistrement d’informations d’identification pour le Workday RH spoke

    Créez un enregistrement d’informations d’identification pour l’instance Workday RH . Les Workday RH alias de connexion et d’informations d’identification du spoke utilisent ces informations d’identification pour autoriser des actions.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tous > Connexions et informations d'identification > Informations d'identification.
    2. Cliquez sur Nouveau.

      Le système affiche ce message : Quel type d’informations d’identification voulez-vous créer ?

    3. Sélectionnez Informations d'identification OAuth 2.0.
    4. Renseignez ces valeurs sur le formulaire.
      Tableau 3. Formulaire Informations d'identification OAuth 2.0
      Champ Description
      Nom Nom permettant d'identifier l'enregistrement de façon unique. Par exemple, Workday RH Cred.
      Actives Option permettant d'utiliser activement l'enregistrement des informations d'identification.
      Profil de l'entité OAuth Profil de l’entité OAuth créé lors de l’inscription en Workday RH tant que fournisseur OAuth. Par exemple, Profil OAuth.
    5. Cliquez avec le bouton droit sur l'en-tête du formulaire, puis cliquez sur Envoyer.
    6. Pour générer le jeton OAuth, cliquez sur le lien connexe Obtenir le jeton OAuth.

    Créer un enregistrement de connexion pour le spoke Workday RH

    Créez un enregistrement de connexion pour votre Workday RH instance. Les alias de connexion et d’informations d’identification du spoke Workday RH utilisent ces connexions pour effectuer des actions dans Workday RH.

    Avant de commencer

    Rôle requis : admin.

    Procédure

    1. Accédez à la Tous > Connexions et informations d'identification > Alias de connexion et d’informations d’identification.
    2. Ouvrez l’enregistrement d’alias WorkdayHR.
    3. Dans l’onglet Connexions , cliquez sur Nouveau.
    4. Renseignez ces champs sur le formulaire.
      Remarque :
      Assurez-vous de créer l’enregistrement de connexion dans l’application Spoke Workday RH .
      Tableau 4. Formulaire de connexion
      Champ Description
      Nom Nom permettant d'identifier l'enregistrement de façon unique. Par exemple : Connexion RH Workday.
      Informations d'identification Enregistrement d’informations d’identification créé pour le spoke Workday RH. Par exemple, Workday RH Cred.
      Alias de connexion Enregistrement d'alias associé à cette connexion.
      URL de connexion URL pour se connecter à votre Workday RH instance.
      Actives Option permettant d’utiliser activement l’enregistrement de connexion.
    5. Dans l’onglet Attributs , renseignez ces valeurs.
      Champ Valeur
      Nom de locataire Nom du locataire de votre Workday application.
      Version v1
    6. Cliquez sur Envoyer.