Ir para o conteúdo principal
Documentação
Documentação
Administrator Guide
Última atualização: 2026-03-13
Registrar agentes externos

Registrar agentes externos

Pré-requisitos

Pode ser necessário executar etapas adicionais para habilitar essa funcionalidade com base no contrato de serviço de assinatura da sua organização. Sua organização está no Acordo de serviço principal (MSA) ou no Acordo de serviço principal universal (UMSA). Para determinar o acordo de serviço da assinatura da sua organização:
  1. Selecione o avatar do seu perfil no Workday Community .
  2. Selecione
    Perfil de
     .
  3. Na página do seu perfil, selecione o nome da sua organização, que está abaixo do seu nome e ao lado do título do cargo.
  4. Visualize o seu valor
    do Acordo de serviço de assinatura
     .
Se o valor for:
Os créditos variáveis são necessário apenas para fazendo o registro e usar agentes em seus locatários de produção. Você não poderá registrar e usar quaisquer agentes em produção até que aceite esses acordos. O UMSA é necessário para locatários de produção e não de produção para agentes criados pelo Workday. O UMSA não é necessário para locatários que não são de Production para agentes autocriados.
Definir o sistema de registro do agente .
Segurança:
  • domínio
    Agent Management Hub
     na área funcional Agent System of Record. Obrigatório para validar que o agente está registrado no Workday.
  • domínio
    Manage Agents
     na área funcional Agent System of Record. Obrigatório para a ativação e configuração da habilidade .
  • Domínio
    Set Up: Tenant Setup - Security
     na área funcional System. Obrigatório para registro.

Contexto

Atualmente, você só pode registrar e definir agentes externos no Workday usando a API ASOR. Os agentes externos são definidos e registrados simultaneamente usando a API. Não são duas etapas separadas. Você pode usar qualquer cliente de API de sua preferência para invocar a API.
Pontos de extremidade de registro:
  • REST API Endpoint:
     https://us.agent.workday.com/asor/v1/agentDefinition.
  • Token Endpoint:
     https://us.agent.workday.com/auth/oauth2/<Tenant_Name>/token
  • Ponto de extremidade de autorização:
     https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagement1&redirect_uri=<redirect_uri>
Para obter informações relacionadas a outras disponibilidade regional fora dos EUA, consulte a documentação do Agent gateway:Referência: disponibilidade regional do Agent gateway .

Opções de autenticação:

Para registrar agentes externos, você precisa de um token de acesso em sua invocação de API do ASOR. Abaixo estão as diferentes opções para obter um token para invocar a chamada à API ASOR.
Opção 1: autenticar manualmente um cliente de API
  1. Acesse a tarefa
    Register API Client
     .
    • Nome de cliente:
       insira um nome identificável exclusivo para seu agente. Recomendamos que você use um cliente separado para cada agente a fim de facilitar o gerenciamento.
    • Tipo de concessão do cliente:
      concessão do código de autorização
       .
    • Tipo de token de acesso:
      portador
       .
    • URI de redirecionamento:
       insira um URL para redirecionar os usuários após a autorização.
    • Scope (áreas funcionais):
      Agent System of Record
       .
    • Incluir escopo de propriedade da Workday :
       marque esta caixa de seleção.
  2. Copie e salve os valores
    de ID de cliente
     e
    Chave secreta cliente
     . Você pode usá-los para obter um token de acesso para chamar a API de definição.
  3. Cole este URL em uma nova janela. Ela deve redirecionar você para google.com com um código anexado que você pode usar para chamar a API:
    https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagement1&redirect_uri=<redirect_uri>
  4. Crie uma nova solicitação usando um cliente de API externo (exemplo: Brunday):
    https://<tenantHost>/ccx/oauth2/<tenantName>/ token.
    • Corpo:
      Grant_type=orderization_code&code=< expiration_code>&client_id=<clientID>&client_confident=<ClientSecret>
    • Autenticação: nome de usuário =
      <ClientID>
       , senha =
      <ClientSecret>
       .
    • Isso gera um token de acesso e um token de atualizar que você pode usar para chamar a API de definição do agente ASOR.
    • Durante a execução dessa etapa, considere:Conceito: considerações do ASU do agente externo .
O usuário que fazendo o registro o agente deve ter acesso ao domínio Setup: Agents na área funcional Agent System of Record para registrar um agente usando a API ASOR.
Opção 2: autenticar usando o Extend
Se você é usuário do Workday Extend ou do Workday Orchestrate, pode recuperar um token de acesso por meio do site de desenvolvedor do Workday.
  1. Acesse desenvolvedor.workday.com e login; fazer login em.
  2. No canto superior direito, clique no menu do usuário. O menu deve exibir o nome atual da sua empresa .
  3. Clique em
    Locatário
    Login no locatário
    .
  4. Selecione seu ambiente e locatário e clique em
    Connect to Tenant
     .
  5. Faça login no locatário. Você deve login; fazer login com uma conta que tenha acesso ao domínio
    Setup: Agents
     na área funcional Agent System of Record para registrar um agente usando a API ASOR.

Registrar um agente externo usando a API ASOR

Pré-requisitos:
  • Um token de acesso para uma conta que tem acesso ao domínio
    Setup: Agents
     na área funcional Agent System of Record.
  • Um cliente de API de sua escolha
  • Segurança: estes domínios na área funcional System:
    • Custom Report Creation
    • Manage: All Custom Reports
    • Report Tag Management
Contexto:
Para registrar um agente externo, você deve:
  • Localize as IDs Workday (WIDs) das APIs Workday relevantes (SOAP e REST) que você pretende incluir na definição de ferramentas do seu agente criando um relatório personalizado.
  • Localize o provedor de agentes usando a tarefa
    Visualizar provedor de agentes
     .
  • Chamar a API REST ASOR
Localizar WIDs com base em SOAP e REST para definição de ferramentas do agente
  1. Acesse a tarefa
    Criar relatório personalizado
    .
  2. Durante a criação do relatório, considere:
    Opção
    Descrição
    Tipo de relatório
    Selecione
    Avançado
    .
    Optimized for Performance
    Desmarque esta caixa de seleção.
    Fonte de dados
    Selecione
    Public Web Services
     para APIs SOAP e
    All Public Service Operations
     para APIs REST.
  3. Para APIs SOAP: na página
    Editar relatório personalizado
     , na guia
    Colunas
     da definição do relatório, adicione estas linhas:
    Objeto de negócios
    Campo
    Serviço Web
    Serviço Web
    Operação de serviço Web
    Nome da operação de serviço Web
    Operação de serviço Web
    ID Workday
  4. Para APIs REST: na página
    Editar relatório personalizado
     , na guia
    Colunas
     da definição do relatório, adicione estas linhas:
    Objeto de negócios
    Campo
    Operação de serviço
    Serviço
    Operação de serviço
    Name
    Operação de serviço
    ID Workday
  5. Salve e execute o relatório.
Conforme você recupera WIDs para suas APIs, você também pode fazer referência cruzada a estas listas:
Localizar o provedor de agentes
Os provedores de agentes se referem a quem criou o agente e são exibidos no campo
Criado por
 no perfil do agente.
  1. Acesse a tarefa
    Visualizar provedor de agentes
     , com protegido para o domínio
    Setup: Agents
     na área funcional Agent System of Record.
  2. Use a ID do provedor em sua chamada à API de registro de agente.
Localizar a plataforma do agente
As plataformas do agente se referem à plataforma ou sistema externo em que o agente é desenvolvido e executado, e são exibidas no campo
Criado em
 no perfil do agente.
  1. Acesse a tarefa
    Visualizar plataformas de agentes
     , com protegido para o domínio Setup Agents na área funcional Agent System of Record.
  2. Use a ID da plataforma em sua chamada à API de registro de agente.
Chamar a API REST ASOR
Crie uma nova solicitação para registrar seu agente usando um cliente de API externo. Exemplo: Bruna.
Durante a criação da solicitação, considere:

Hub de gestão de agentes

Depois de carregar com êxito a definição do agente no Workday, você pode verificar se ela está registrada visualizando-a no
Hub de gestão de agentes
 .
  1. Acesse o relatório
    Hub de gestão de agentes
     .
  2. Clique em
    Registro de agente
     para exibir uma lista dos seus agentes.
  3. Clique em um agente para exibir as informações gerais sobre ele.

Próximas etapas

Configure seu agente no Workday.