Conceito: API de serviço de ouvinte

Para publicar mensagens em uma integração do Studio com um serviço de ouvinte habilitado, use a API de serviço de ouvinte. Usando a API REST fornecida, você pode publicar uma mensagem personalizada (definida por você ou pelo serviço externo com o qual está se integrando) em uma integração do Studio. Você pode publicar uma mensagem, desde que tenha criado a integração do Studio para reconhecer e executar a ação necessária.

Segurança da API de serviço de ouvinte

A operação POST de serviço Web de entrada deve ser autenticada por um destes dois métodos:

Autenticação básica
: inclua uma ID de usuário e uma senha do Workday. A ID de usuário do Workday tem o seguinte formato:

username@tenant_name

, em que

tenant_name

é o nome do locatário que você está acessando.

OAuth
: inclui um token de acesso de portador, que você obtém usando uma solicitação cURL. Durante o processo, você precisa destes valores:

No seu cliente de API do Workday: ID de cliente, Ponto de extremidade de autorização e Ponto de extremidade do token.

Em um gerador de códigos PKCE: Verificador de código e Desafiação.

Em um navegador: Código de autorização.

Para obter as etapas detalhadas, consulte Iniciar integrações usando tokens OAuth 2.0 Bearer.

A Workday recomenda que você use a autenticação OAuth para maior segurança.

Quando um ISU é atribuído ao sistema de integração, a conta de usuário que executa a solicitação de avaliador deve ser membro de um grupo de segurança que concede permissão para iniciar a integração.

Quando nenhum usuário de sistema de integração (ISU) é atribuído, a conta de usuário que executa a solicitação de avaliador deve ser membro de um ou mais grupos de segurança que concedem permissão para:

Inicie a integração.

Acesse todas as APIs de dados usadas pela integração.

Cada locatário tem seu próprio identificador uniforme de recursos (URI), para o qual você direciona as solicitações de publicação de serviço Web. Para obter os pontos de extremidade mais recentes e informações sobre como determinar o URI do seu data center e ponto de extremidade, consulte a página Data Centers do Workday no Workday Community.

Inclua um cabeçalho HTTP X-Tenant: tenant_name na sua chamada de API.

Estrutura de repositório em nuvem

Você acessa as integrações do Studio que implementou no Repositório do Workday Cloud usando esta hierarquia:

Repositório na nuvem: cada locatário tem um único repositório na nuvem.

Coleção: cada repositório em nuvem armazena uma ou mais cobranças. Cada coleção tem um nome exclusivo.

Integrações: cada coleção inclui uma ou mais integrações do Studio. Cada integração tem um nome e um valor workday_in_id
exclusivos.

Especifique uma integração do Studio usando o formato de URI:

Tenant_URI
/ccx/cc-cloud-repo/launchers/Collection_Name
/Integration_Name
/Workday_in_ID
?Launch_parameter_name
=valor
:

Variável	Descrição
Tenant_URI	O URL do locatário.
collection_name	Identifica a cobrança.
integration_name	Uma integração específica do Studio
workday_in_id	ID específica da integração.

Operação de serviço Web disponível

A API de serviço de ouvinte oferece uma única operação Publicar para enviar uma mensagem a uma integração do Studio:

Categoria	Valor
Formato	POST URI /ccx/cc-cloud-repo/launchers/Collection_Name /Integration_Name /Workday_in_ID
Exemplo	POST https://Enterprise-services1.myworkday.com/ccx/cc-cloud-repo/collections/HelloCloudCollection/HelloCloud/StartHere
Resposta	Publica uma mensagem na integração Olá Cloud . Para obter uma integração de amostra que usa o serviço de ouvinte, consulte a publicação do serviço de ouvinte no Workday Community.