Configurations pour utiliser Workday REST API

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture
  • Configurez votre ServiceNow instance pour effectuer des actions qui utilisent l’API Workday REST.

    Avant de commencer

    • Demandez un Hub d'intégration abonnement.
    • Activez Workday RH le spoke.
    • Dans Workday, obtenez ces valeurs 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 Workday REST si vous devez utiliser ces 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é
    Remarque :
    Ces configurations sont nécessaires pour utiliser les actions de spoke basées sur REST.

    S’inscrire 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 Tout > 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
      Demande Application dans laquelle l’enregistrement est applicable. Sélectionnez le spoke Workday RH.
      ID client ID client généré lors de l’enregistrement 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’enregistrement 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.
      Actif 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éé.

    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 Tout > 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 2. 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.
      Actif 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 Tout > 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 3. Formulaire de connexion
      Champ Description
      Nom Nom permettant d'identifier l'enregistrement de façon unique. Par exemple : Connexion RH Workday.
      Information 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 vous connecter à votre Workday RH instance.
      Actif Option permettant d’utiliser activement l’enregistrement de connexion.
    5. Renseignez ces valeurs dans l’onglet Attributs .
      Champ Valeur
      Nom de locataire Nom du locataire de votre Workday application.
      Version v1
    6. Cliquez sur Envoyer.