Guia de integração de motores bônus

O Xtremepush suporta integração com motores bônus, permitindo que você destaque e atribua promoções diretamente de campanhas CRM. Quando os requisitos de integração são atendidos, novas conexões normalmente podem ser configuradas em poucos dias.

Antes de começar

Para que a integração do motor bônus seja possível, os seguintes requisitos devem ser cumpridos.

Autenticação e acesso à API — Você deve ser capaz de criar uma conexão segura e autenticada com o motor bônus e interagir com ele via API.

Requisitos principais do endpoint — No mínimo, a API do motor bônus deve suportar um dos seguintes padrões:

• Recupere uma lista de bônus ativos e aloque o ID do Bônus X ao ID do Cliente Y

• Recupere uma lista de tipos de bônus e aloque um bônus do tipo X com valor Y ao ID do Cliente Z

Capacidades opcionais — Quando suportado, o Xtremepush também pode permitir:

• Desalocação de bônus — Remover um bônus de um cliente pelo mesmo endpoint de atribuição (desalocar ID de bônus X do ID de Cliente Y). Note que a alocação e a desalocação são tratadas por meio de um único ponto final; endpoints separados para cada operação não são suportados.

• Captura de eventos pós-campanha — O motor bônus publica eventos transacionais de volta ao Xtremepush após um usuário ser adicionado a um público bônus. Isso é feito pelo caminho padrão de integração do fluxo de eventos (por exemplo, Bônus Reivindicado ou Bônus Creditado).

Integração técnica

Configuração padrão

O Xtremepush oferece uma configuração baseada em configuração que pode ser implementada em poucos dias (excluindo o tempo de entrega), desde que o motor bônus atenda aos seguintes requisitos.

Métodos de autenticação suportados

Os seguintes são suportados de imediato:

• Token de portador

• Token de cabeçalho

• Nome de usuário e senha

• OpenID

• OAuth

Requisitos da API

• Solicitações e respostas no formato JSON com níveis mínimos de aninhamento

• Um endpoint para recuperar uma lista de promoções ou bônus ativos

• Um único endpoint para alocar e remover bônus para os usuários

Funcionalidade padrão

Como parte da integração padrão, o Xtremepush suporta atribuição dinâmica — definindo valores fixos ou com base em variáveis encontradas nos atributos do jogador ou que acionam eventos. Quando é necessária uma configuração avançada por variável bônus, isso é gerenciado via endpoint /sync , permitindo que os clientes definam variáveis por bônus.

O que precisamos de você

Para começar, exigimos o seguinte da sua equipe, como uma especificação OpenAPI com exemplos sempre que possível:

• Documentação da API para seu motor bônus

• Confirmação do método de autenticação em uso

• A URL base para os endpoints da API

• Detalhes completos de todos os campos necessários ao atribuir ou remover um bônus — os nomes exatos, tipos e quaisquer requisitos condicionais são importantes para confirmar antecipadamente para evitar atrasos durante a configuração

Formato esperado da API - simples

Bônus de lista

GET /bonus/fetch
Authorization: Bearer <token> or Basic <credentials>
Content-Type: application/json

Resposta esperada:

[
  {
    "id": "183",
    "name": "Name of Promotion"
  },
  {
    "id": "184",
    "name": "Name of Promotion"
  }
]

Bônus de atribuição - lotado

POST /bonus/assign
Authorization: Bearer <token> or Basic <credentials>
Content-Type: application/json

Órgão esperado do pedido:

{
  "promotionId": "510948",
  "amount": 100.00,
  "userIds": ["1261853", "1261854"]
}

Integrações sob medida

Quando um motor bônus possui um método de autenticação não suportado, um protocolo de comunicação diferente (por exemplo, JSON-RPC ou XML) ou um formato complexo de solicitação/resposta, o Xtremepush pode construir uma integração personalizada quando for prático e viável. Isso gerará um prazo adicional de entrega e pode gerar custos de instalação e manutenção.

Eventos pós-campanha

Sempre que possível, o motor bônus deve postar eventos transacionais de volta no Xtremepush após o usuário ser adicionado a um público bônus. Esses podem ser enviados ao ponto final do evento da mesma forma que qualquer outro evento transacional (por exemplo, depósito, aposta feita, resultado da aposta).

No mínimo, os seguintes eventos devem ser incluídos:

• Bônus Creditado — Demitido quando um usuário atende a qualquer critério adicional e o bônus é adicionado à carteira

• Bônus Reivindicado — Demitido quando um usuário consegue reivindicar o bônus com sucesso

Integrações existentes de terceiros

O Xtremepush possui integrações pré-construídas com os seguintes provedores de motores bônus: