Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Since integrations in English isn’t common the guide may not be fully current. Please ask Buzzvil’s Tecnical Support Manager before integrating whether the API guide is up to date.

To reward users, it is it’s necessary to integrate the Reward Request Postback API. Postback requests are conducted in a Server-to-Server communication format for security purposes.

Info

Summary of Procedures

1. Establish a server endpoint capable of receiving reward requests from Buzzvil (we refer to this endpoint's URL as the postback URL).

2. Perform Server-to-Server integration as instructed in this guide.

3. Provide the postback URL to Buzzvil's Technical Support Manager.

...

Table of Contents

Introduction

This Reward Request API is designed to 1. inform publishers when users receive points through Buzzvil, allowing them to send accrual requestsparticipate in an ad (event), 2. request publishers to reward users, and 3. inform Buzzvil whether the reward accrual was successful.

항목

내용

1

Request Direction

Buzzvil → Publisher

2

HTTP Request method

POST - application/x-www-form-urlencoded

3

HTTP Request URL

Endpoint on the publisher’s server

4

HTTP Request Parameters

Refer to the below “HTTP Request Parameters” table

5

HTTP Response Code

The Buzzvil server determines whether the result of the reward request was successful based on the response code received from the publisher’s server.

  • Status
    title200
    (OK),
    Status
    title204
    (No Content),
    Status
    title409
    (Duplicate Request):
    Status
    colourGreen
    titlesuccessful

    • Response codes when the publisher server successfully processes the request (points accrued to the user)

    • Resond with

      Status
      title409
      when the server’s already accrued points to the user but duplicate requests were received

  • Response codes other than

    Status
    title200
    ,
    Status
    title204
    ,
    Status
    title409
    :
    Status
    colourRed
    titlefailed

    • Retry postback request up to 5 times

    • Retry intervals are roughly 1 minute, 10 minutes, 1 hour, 3 hours, and 24 hours from initial failure

Response codes other than

Status
title200
: Refer to standard HTTP response codes

Note

Even if the body contains error content, no retry postback will be attempted if the response code is

Status
title200

...

To receive reward request postbacks from Buzzvil servers, please whitelist the following IPs on your firewall.

  • 5418.179.64158.39.245

  • 52.68.114.43

  • 13.113.136.11

  • 52.194.132.196

  • 13.114.88.146

Request Parameter Verification 
Status
colourRed
titleOPTIONAL

...