Pular para o conteĆŗdo principal

šŸš€ Envio de Recompensas via API

Endpoint

POST <https://api.bonuz.io/v4/experiences/:NOME-DA-EXPERIENCIA/triggers>

Nota: O :NOME-DA-EXPERIENCIA serĆ” informado pela equipe Minu no momento da configuraĆ§Ć£o da campanha.

AutenticaĆ§Ć£o

A autenticaĆ§Ć£o deve ser realizada via Basic Auth no cabeƧalho da requisiĆ§Ć£o.

šŸ”’ O token de autenticaĆ§Ć£o dos ambientes de homologaĆ§Ć£o (HMG) e produĆ§Ć£o (PRD) serĆ” enviado apĆ³s a finalizaĆ§Ć£o da configuraĆ§Ć£o da experiĆŖncia pelo time de Projetos da Minu.

Exemplo de cabeƧalhos:

Authorization: Basic <seu_token>
Content-Type: application/json
Accept-Language: pt-br

Estrutura do Body

{
  "event": "reward-given",
  "registeredCallbackUrl": "<https://callback.seusite.com/registered>",
  "processedCallbackUrl": "<https://callback.seusite.com/processed>",
  "data": {
    "orderId": "pedido001",
    "mobile": "5511999999999",
    "email": "cliente@email.com",
    "prizeName": "bonusCelular"
  }
}

Sobre os campos:

  • event: Nome do evento configurado. O evento Ć© uma aĆ§Ć£o
  • registeredCallbackUrl (opcional): URL de callback para confirmaĆ§Ć£o de registro.
  • processedCallbackUrl (opcional): URL de callback para informaĆ§Ć£o do processamento.
  • data:
    • orderId: Identificador Ćŗnico do pedido, obrigatĆ³rio. Este valor deve ser definido pelo Cliente Corporativo e deve ser exclusivo para cada pedido. Caso o mesmo orderId seja reutilizado, o pedido serĆ” cancelado automaticamente por duplicidade.
    • mobile: Telefone do destinatĆ”rio.
    • email: Email do destinatĆ”rio.
    • prizeName: ID da recompensa a ser enviada.

Artigos relacionados