Utilização de APIs para integrar interfaces do SAP Entitlement Management (SEM)

No SAP Entitlement Management, é necessário um API para efetuar um trabalho de interface porque permite a comunicação e o intercâmbio de dados entre o SAP Entitlement Management e outros sistemas ou aplicações. APIs definem e implementam interfaces de entrada e saída no SAP Entitlement Management.

As interfaces no SAP Entitlement Management referem-se aos mecanismos e protocolos de comunicação que facilitam o intercâmbio de dados entre o gerenciamento de direitos e os sistemas externos.

As APIs externas no SAP Entitlement Management são assim nomeadas porque são projetadas para fornecer uma interface padronizada para interagir com o sistema de gerenciamento de direitos. Essas APIs servem como uma ponte entre o sistema de gerenciamento de direitos e outros sistemas externos, permitindo o intercâmbio de dados e comunicação por meio de um conjunto definido de interfaces de programação.

Vamos explorar os diferentes tipos de APIs e interfaces que suportam o gerenciamento de direitos.

No SAP Entitlement Management, uma interface de entrada é um mecanismo que permite que sistemas externos enviem dados e informações para a aplicação SAP. Ele pode incluir informações relacionadas a dados de direito, detalhes do cliente, informações do produto e muito mais. A interface de entrada fornece uma forma de os sistemas externos comunicarem com o SAP Entitlement Management e atualizarem ou sincronizarem dados relevantes no sistema.

Estão disponíveis várias APIs para definir a interface de entrada. Estes incluem:

• APIs de configurações
• APIs de dados mestre
• APIs de direito
• APIs de consumo
• APIs de administração de usuários (está disponível uma API)
• APIs de provisionamento (uma API disponível)

Uma interface de saída no SAP Entitlement Management refere-se a um mecanismo que permite que o SAP Entitlement Management envie dados e informações para sistemas externos envolvidos no processo de cumprimento.

As interfaces de saída enviam direitos para o sistema de gerenciamento de ordens. Estão disponíveis várias APIs para definir a interface de saída. Estes incluem:

• APIs de resposta de configuração
• APIs de solicitação e resposta de dados mestre
• APIs de resposta de direito
• APIs de resposta de consumo
• APIs de resposta de administração de usuários (está disponível uma API)
• API de notificação de evento: quando uma ação de evento é definida como "Enviar notificação", assim que o evento é acionado, a notificação é enviada por meio da API de notificação de evento
• APIs de registros de tarefas em segundo plano (duas APIs disponíveis)
• APIs de provisionamento

As APIs desempenham um papel crucial na facilitação do intercâmbio de dados e comunicação em ambas as direções, permitindo uma integração perfeita com sistemas e parceiros externos.

A API de geração de direito simplifica o processo transferindo campos de dados relevantes para o direito mapeado, garantindo um gerenciamento de direitos preciso e eficiente por meio de um sistema bem definido e automatizado.

O payload de um API de geração representa o valor do documento de vendas do sistema upstream. Esta API aciona o processo ponta a ponta no SAP Entitlement Management. O valor desta API é transferido para direitos mapeados por meio do mapeamento de oferta para direito. Cada direito mapeado passa a regra de geração correspondente com o conjunto de regras configurado e é utilizado para criar um novo direito ou atualizar direitos existentes no sistema.

O payload de um API de geração é configurável. Selecione o bloco Explorar APIs e selecione o ID para API Entitlement Generation v2. Na página de configuração, você pode adicionar novos campos ao nó predefinido Cabeçalho ou ao respectivo nó inferior Item. Você também pode adicionar um subnó em Itens.

O valor dos campos "Header.Document Type", "Header.Document Number" e "Item.Item Number" é transferido para "Reference Document Type", "Reference Document Number" e "Reference Item Number" no direito mapeado. Se o direito mapeado for usado para criar um novo direito, esses valores são salvos como "Tipo de documento de origem", "Número do documento de origem" e "Número do item da iniciação" do novo direito. Se o direito mapeado for utilizado para atualizar um direito existente, os valores são salvos com o mesmo nome no histórico de atualização do direito existente.

O valor dos campos "ID da oferta" e "Sistema de oferta" será usado para encontrar a configuração "Mapeamento de oferta para direito" correspondente.

O valor dos campos "ID do cliente", "Sistema do cliente", "ID da oferta", "Sistema de oferta" e "Sistema de origem" serão transferidos diretamente para o direito mapeado.

O valor de "Sistema fonte" pode ser encontrado no "sistema do cliente" ou no "sistema de oferta" atualizado nos dados mestre. Caso contrário, ele deve ser mantido em Configurar dados cadastrais de direito Manter configuração básica Sistema de origem do direito.

O campo "Método de geração" está obsoleto. Independentemente do valor neste campo, o atributo Direito "Método de geração" é sempre automático se o direito for gerado via API.

O valor do nó "Contatos" no nó "Item" é transferido diretamente para o Direito mapeado como a pessoa de contato atribuída ao Direito. O sistema utiliza "ID interno" para encontrar a pessoa de contato correspondente no sistema. Se "ID interno" estiver vazio, o sistema usará "ID externo" mais "Sistema de origem" para localizar os registros correspondentes.

Considere também que o nó Direito de documento de vendas em Item é usado no conteúdo de integração padrão entre SAP Entitlement Management e SAP Subscription Billing. Ela contém uma lista de números de direito associados ao documento de vendas atual. Este nó também pode ser configurado em um conjunto de regras para atender às necessidades do cliente.

A API retorna as informações da pessoa de contato atribuídas ao direito gerado ou atualizado. Você pode definir um valor do parâmetro do cabeçalho da solicitação x-ems-Contacts como completo.

Para permitir que o API retorne somente o ID e a função de direito da pessoa de contato atribuída ao direito gerado ou atualizado, defina o valor do parâmetro de cabeçalho da solicitação x-ems-Contacts como básico. Este parâmetro também não precisa ser adicionado ao cabeçalho da solicitação.

O valor do campo Fuso horário do direito no nível do cabeçalho é transferido diretamente para o direito mapeado como fuso horário do direito.

Para uma única solicitação de geração de direito, o sistema processa um máximo de 1000 criações ou atualizações de direitos. Se o número de direitos criados exceder 1000, o sistema retorna uma mensagem de erro.

O API de geração permite a você criar dados mestre com um documento de vendas de acordo com as seguintes regras:

• Um usuário pode adicionar informações de dados mestre para uma ordem no nó MasterDataCreation. Os dados mestre incluem o cliente, a oferta e a pessoa de contato.
• É possível criar vários registros de dados mestre. No entanto, os dados mestre devem aparecer no cabeçalho ou item do documento de vendas, ou serão ignorados pelo sistema.
• Um máximo de 10 registros de dados mestre são permitidos no payload ao enviar uma solicitação no modo de sincronização.
• Um máximo de 1000 registros de dados mestre são permitidos no payload ao enviar uma solicitação no modo assíncrono.

Se o sistema detectar registros no nó MasterDataCreation, ele filtrará primeiro os registros de dados mestre que não aparecem no documento de vendas e criará os dados mestre. Esta API não administra a atualização de dados mestre. Se os dados mestre a serem criados já existirem, eles serão ignorados pelo sistema.

Além disso, o sistema não verificará se o valor de dados mestre indicado é o mesmo que qualquer registro de dados mestre existente.

O processo de criação de dados mestre é cancelado ao encontrar qualquer erro durante o processo.