Pular para o conteúdo principal

Melhores Práticas de Integração PEP

Neste guia, vamos descobrir as melhores práticas essenciais para garantir um processo de integração perfeito. Da revisão completa da documentação à autenticação segura e ao tratamento de erros, navegaremos pela paisagem da integração com confiança.

1- Revise a Documentação Cuidadosamente: Familiarize-se com nossa documentação de API para entender seus recursos, endpoints, parâmetros e instruções de uso.

2- Autenticação: Implemente uma autenticação segura usando OAuth para garantir o acesso autorizado aos nossos endpoints de API e proteja adequadamente o ID do Cliente OAuth e o Segredo do Cliente.

3- Tratamento de Erros: Trate os erros de forma adequada, verificando as respostas de erro e implementando a lógica de tratamento de erros apropriada em seu aplicativo. Considere implementar mecanismos de retry para erros transitórios.

4- Retry de Operações: Implemente a lógica de retry para erros transitórios, como timeouts de rede ou indisponibilidade temporária do serviço. Use estratégias de exponential backoff para aumentar gradualmente os intervalos de retry.

API do Operador

A API do operador refere-se aos endpoints de API com os quais você precisa se integrar para permitir que o PEP envie solicitações ou recupere os dados necessários para qualquer processo do PEP.

Bônus

Se você quiser permitir que o PEP atribua bônus por meio do seu sistema de bônus, é necessário implementar a API de Atribuição de Bônus. Essa API permite que o PEP envie bônus de diferentes maneiras, por exemplo, em campanhas de marketing no CRM ou como recompensa quando um jogador atualiza níveis ou classificações, bem como quando um objetivo da missão é alcançado.

Como melhor prática, recomendamos que você implemente a API de Obtenção de Bônus, esse endpoint permite que o PEP permita automaticamente que os operadores administradores listem os bônus disponíveis em seu sistema de bônus, e os operadores administradores podem facilmente escolher o bônus desejado para recompensas de fidelidade ou em campanhas de marketing do CRM:

Autocompletar de bônusAutocompletar de bônus

Se você não definir essa API opcional, o operador precisará adicionar manualmente o identificador exclusivo do bônus ou o identificador exclusivo da oferta de bônus, o que pode causar erros devido à intervenção humana no processo. Se o PEP fizer a chamada da API e o endpoint não for implementado, é usado um campo de entrada de texto para permitir que os operadores insiram o identificador exclusivo do bônus:

Bônus manualBônus manual

API de Reconciliação

Se você estiver usando o CRM e, por regulamentação, houver informações que seus jogadores precisem atender para receber campanhas de marketing, o PEP poderá identificar se há informações faltantes para os jogadores que você registra em nossa plataforma.

Para garantir o alinhamento de dados entre sua plataforma e o PEP, é essencial desenvolver um processo de reconciliação. Esse processo serve como uma salvaguarda para garantir que, se o PEP detectar qualquer informação de jogador ausente, você (o operador) será notificado para sincronizar as informações ausentes usando as operações CRUD de jogador do PEP. Para evitar problemas de regulamentação, as solicitações de reconciliação são armazenadas em um log de auditoria.

Como melhor prática, recomendamos implementar a API de Reconciliação, para que você possa nos enviar todas as informações dos jogadores usando as operações CRUD de Dados do Jogador

Informações do Jogador

As melhores práticas para registrar informações de jogadores estão descritas nesta seção do documento:

Dê uma olhada nessa documentação para ver como enviar corretamente os dados de informações do jogador para o PEP.

Lealdade - Gamificação

Se você estiver usando apenas nosso programa de fidelidade/gamificação, as integrações mínimas de que precisamos são:

Informações de Transação:

Eventos do Jogador: