Configurações para usar Workday REST API

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura

    • Configure sua instância ServiceNow para executar ações que usam a REST API Workday.

    Antes de Iniciar

    • Solicitar uma assinatura de Integration Hub.
    • Ative o Workday de RH spoke.
    • No Workday, obtenha esses valores e registre-os para uso posterior. Estes valores são necessários para registrar seu cliente:
      • ID de cliente
      • Segredo do cliente
      • Workday Endpoint de REST API
      • Endpoint de token
      • Endpoint de autorização
    • Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Workday A REST e a API Report-as-a-Service (RAAS) funcionam com o OAuth 2.0 para autorizar o acesso aos recursos em seu locatário Workday. Para usar o OAuth 2.0, você deve registrar seu cliente no locatário, usando a tarefa Registrar cliente de API.

    Configure sua instância ServiceNow para usar a REST API Workday se você precisar usar estas ações de spoke baseadas em REST:
    • Obter minha estrutura de relatório
    • Pesquisar campos personalizados do objeto
    • Atualizar campos personalizados do objeto
    • Pesquisar comprovante de pagamento
    • Pesquisar total de gratificações usando relatório
    • Pesquisar relatórios personalizados
    • Pesquisar itens da caixa de entrada
    • Pesquisar detalhes do plano de benefícios e de mérito de um funcionário
    • Pesquisar WID de referência de calendários de férias de um funcionário
    • Pesquisar WID de referência de calendários de programação de um funcionário
    • Extrai calendários de férias de um funcionário
    Nota:
    Essas configurações são necessárias para usar as ações de spoke baseadas em REST.

    Registrar Workday de RH como um provedor OAuth

    Registre a instância Workday de RH como o provedor OAuth para que a instância ServiceNow possa solicitar tokens OAuth 2.0.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > OAuth de Sistema > Registro de aplicações.
    2. Clique em Nova.
      O sistema exibe esta mensagem: Que tipo de aplicação OAuth?.
    3. Selecione Conectar-se a um provedor OAuth de terceiros.
    4. No formulário, preencha estes valores.
      Tabela 1. Formulário de registros de aplicações
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro. Por exemplo, insira: OAuth de RH no Workday
      Aplicação Aplicação na qual o registro é aplicável. Selecione Spoke de RH do Workday.
      ID de cliente ID de cliente gerado ao registrar seu cliente.
      Segredo do cliente Segredo do cliente gerado ao registrar seu cliente.
      URL de Autorização Endpoint de autorização gerado ao registrar seu cliente.
      URL de Token Endpoint de token gerado ao registrar seu cliente.
      Redirecional URL Endpoint de retorno de chamada OAuth neste formato: https://<instance>.service-now.com/oauth_redirect.do
      Tipo de concessão padrão Tipo de concessão usado para estabelecer o token. Selecione Código de autorização.
      Ativo Opção para usar ativamente o registro da aplicação.
    5. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
      Um perfil de entidade OAuth é criado.

    Criar um registro de credencial para o spoke Workday de RH

    Crie um registro de credencial para a instância Workday de RH. O alias de conexão e credencial do spoke Workday de RH usa essas credenciais para autorizar ações.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > Conexões e Credenciais > Credenciais.
    2. Clique em Nova.

      O sistema exibe a mensagem: Que tipo de Credenciais você deseja criar?

    3. Selecione Credenciais OAuth 2.0.
    4. No formulário, preencha estes valores.
      Tabela 2. Formulário de credenciais OAuth 2.0
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro. Por exemplo, Workday HR Cred.
      Ativo Opção de usar ativamente o registro de credencial.
      Perfil de Entidade OAuth Perfil de entidade OAuth criado durante o registro de Workday de RH como um provedor OAuth. Por exemplo, Perfil OAuth.
    5. Clique com o botão direito no cabeçalho do formulário e clique em Enviar.
    6. Para gerar o token OAuth, clique no link relacionado Obter Token OAuth.

    Criar um registro de conexão para o spoke de RH do Workday

    Crie um registro de conexão para sua instância Workday de RH. Os aliases de conexão e credencial do spoke do RH do Workday usam essas conexões para executar ações em Workday de RH.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > Conexões e Credenciais > Aliases de conexões e credenciais.
    2. Abra o registro de alias, WorkdayHR.
    3. Na guia Conexões, clique em Novo.
    4. No formulário, preencha estes campos.
      Nota:
      Certifique-se de criar o registro de conexão na aplicação Spoke de RH do Workday.
      Tabela 3. Formulário de conexão
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro. Por exemplo, Conexão de RH do Workday.
      Credencial Registro de credencial criado para o spoke de RH do Workday. Por exemplo, Workday HR Cred.
      Alias de conexão Registro de alias associado a esta conexão.
      URL de conexão URL para se conectar à sua instância Workday de RH.
      Ativo Opção para usar ativamente o registro de conexão.
    5. Na guia Atributos, preencha estes valores.
      Campo Valor
      Nome de locatário Nome do locatário da sua aplicação Workday.
      Versão v1
    6. Clique em Enviar.