Template

This method helps get information about a bonus template.

NOTE: This method is optional. The PartnerBoard is the most reasonable way to get information about a bonus template.

The successful response is described in the Templates method section.

POST https://{S2S_API_URL}/bonuses/template

A request examples:

An example using firebase/php-jwt and guzzlehttp/guzzle packages:

use Firebase\JWT\JWT;
use GuzzleHttp\Client;
$PARTNER_SECRET = 'testdemo';
$payload = [
    'cid' => 'fbet',
    'templateId' => 1,
];

$jwtParts = explode('.', JWT::encode($payload, $PARTNER_SECRET, 'HS256'));
$signature = implode('.', [$jwtParts[0], '', $jwtParts[2]]);

// x-sign-jws=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..b_l10uHDIjFiEUbxDGVIEKQ_k8mgDAQdUyKBZcmJ1ew
echo "x-sign-jws=$signature";

// send the request
$body = json_encode($payload, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);

$url = 'https://{S2S_API_URL}/bonuses/template';

$client = new Client();
$response = $client->request('POST', $url, [
    'body' => $body,
    'headers' => [
        "Content-type" => "application/json",
        "x-sign-jws" => $signature
    ]
]);

echo $response->getBody()->getContents();

An example using jsonwebtoken package:

const jwt = require('jsonwebtoken');
const { fetch } = require('undici');

const PARTNER_SECRET = 'testdemo';
const payload = {
    cid: 'fbet',
    templateId: 1,
};

const [jwtHeader, , jwtSignature] = jwt
  .sign(payload, PARTNER_SECRET, {
    algorithm: 'HS256',
    // jsonwebtoken adds iat claim in payload but we need JWT payload to match request body
    // so ask jsonwebtoken to drop redundant fields
    noTimestamp: true,
  })
  .split('.');
const signature = [jwtHeader, '', jwtSignature].join('.');

// x-sign-jws=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..b_l10uHDIjFiEUbxDGVIEKQ_k8mgDAQdUyKBZcmJ1ew
console.log(`x-sign-jws=${signature}`);

// send the request
const req = await fetch('https://{S2S_API_URL}/bonuses/template', {
  method: 'POST',
  body: JSON.stringify(payload),
  headers: {
    'Content-type': 'application/json',
    'x-sign-jws': signature,
  },
});

curl --location 'https://{S2S_API_URL}/bonuses/template' \
--header 'x-sign-jws: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..b_l10uHDIjFiEUbxDGVIEKQ_k8mgDAQdUyKBZcmJ1ew' \
--header 'Content-Type: application/json' \
--data '{"cid": "fbet","templateId": 1}'

The table below describes the following parameters:

Parameter	Type	Description
cid	string	Partner API Key.
templateId	integer	Parameter of the unique identifier of the bonus pattern assigned by Sportsbook.

A response examples:

HTTP status code: 200

{
  "id":1,
  "name":"Bonus freebet",
  "isEnable":true,
  "type":"freebet_standart",
  "cid":"fbet",
  "stage":2,
  "fromTime":1607558400,
  "toTime":1639094400,
  "daysToUse":5,
  "disciplines":[
    "csgo"
  ],
  "freebetData":{
    "minSelection":1,
    "maxSelection":2,
    "minOdd":1.01,"maxOdd":3,
    "betAmount":5,
    "betCount":5,
    "maxWin":100,
    "currency":"USD",
    "maxWinCurrency": "USD"
  },
  "availableCountries": null,
  "availableTournaments": null
}

HTTP status code: 400

Example response body:

{
    "code": 1,
    "message": "Request signature is invalid"
}

Parameter	Type	Description
code	Integer	Error number. Possible error codes:
1 - Request signature is invalid,
5 - Request validation error
message	string	A detailed explanation of the error.

HTTP status code: 422

Example response body:

{
  "message":"The given data was invalid.",
  "errors":{
    "templateId":["The template id field is required."]
  },
  "code": 5
}

Parameter	Type	Description
message	string	A detailed explanation of the error.
errors	object	Detailed information for each validation error.
code	integer	Error code. The default value – 5.

HTTP status code: 404

Example response body:

{
  "message":"Bonus template not found",
  "code":30
}

Parameter	Type	Description
message	string	A detailed explanation of the error.
code	integer	Error code. The default value – 30.