Open Publisher API for Dash services v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Api that allows to pull live offers from dash platform.

Base URLs:

https://demo-dash.vene.io/api/publisher-api/v1

Email: Support

Authentication

HTTP Authentication, scheme: bearer

LiveOffers

Get live offers

Code samples

# You can also use wget
curl -X GET https://demo-dash.vene.io/api/publisher-api/v1/live-offers \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://demo-dash.vene.io/api/publisher-api/v1/live-offers HTTP/1.1
Host: demo-dash.vene.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://demo-dash.vene.io/api/publisher-api/v1/live-offers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://demo-dash.vene.io/api/publisher-api/v1/live-offers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://demo-dash.vene.io/api/publisher-api/v1/live-offers', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://demo-dash.vene.io/api/publisher-api/v1/live-offers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://demo-dash.vene.io/api/publisher-api/v1/live-offers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo-dash.vene.io/api/publisher-api/v1/live-offers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /live-offers

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	The number of items to skip before starting to collect the result set
limit	query	integer	false	The numbers of items to return
page	query	integer	false	The current page
countries[]	query	array[string]	false	Array of countries in format 'countries[]=DE&countries[]=US'
categories[]	query	array[string]	false	Array of categories in format 'categories[]=Betting&categories[]=SomeOtherCategory'
id[]	query	array[integer]	false	Array of live offers identifiers 'id[]=123456'
sort	query	string	false	Sort by. - for decremental sorting.
paused	query	string	false	Show paused offers.
with_trashed	query	string	false	Add deleted entities to result set
only_trashed	query	string	false	Show only deleted entities.

Enumerated Values

Parameter	Value
sort	modified
sort	payout
sort	name
sort	created
sort	id
paused	0
paused	1
with_trashed	0
with_trashed	1
only_trashed	0
only_trashed	1

Example responses

200 Response

{
  "data": [
    {
      "categories": [
        "Betting"
      ],
      "countries": [
        "DE"
      ],
      "created": "2020-09-29T08:36:26Z",
      "deleted": "2020-09-29T08:36:26Z",
      "description": "Description of the offer",
      "id": 123456,
      "name": "Join Now - 50EUR bonus",
      "paused": false,
      "status": "active",
      "tracking_url": "https://example.com/3St",
      "payouts": [
        {
          "amount": "15.32000000",
          "percentage": null,
          "currency": "EUR",
          "type": "fixed",
          "event_type": "consequuntur_5e8ee02fcea31"
        }
      ],
      "offer": {
        "id": 1,
        "preview_url": "https://example.com/3St"
      },
      "os": [
        "string"
      ]
    }
  ],
  "object": {
    "total": 6,
    "x_ray_id": "29290933d69f32044c2193332af68b61",
    "api_version": "v0.7.3-1385-gf00e4020@2019-08-30T12:48:04+02:00",
    "rq_time": "Request time in seconds",
    "offset": 0,
    "limit": 30,
    "page": 1
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfull operation	LiveOfferResponse

Schemas

LiveOffer

{
  "categories": [
    "Betting"
  ],
  "countries": [
    "DE"
  ],
  "created": "2020-09-29T08:36:26Z",
  "deleted": "2020-09-29T08:36:26Z",
  "description": "Description of the offer",
  "id": 123456,
  "name": "Join Now - 50EUR bonus",
  "paused": false,
  "status": "active",
  "tracking_url": "https://example.com/3St",
  "payouts": [
    {
      "amount": "15.32000000",
      "percentage": null,
      "currency": "EUR",
      "type": "fixed",
      "event_type": "consequuntur_5e8ee02fcea31"
    }
  ],
  "offer": {
    "id": 1,
    "preview_url": "https://example.com/3St"
  },
  "os": [
    "string"
  ]
}

LiveOffer

Properties

Name	Type	Required	Restrictions	Description
categories	[string]	true	none	Categories of offers.
countries	[string]	true	none	Countries offer are available in.
created	string(date-time)	true	none	When the offer was created
deleted	string(date-time)¦null	true	none	When the offer was deleted, when not deleted value is null
description	string	true	none	Live Offer description
id	integer(int64)	true	none	Live Offer Id
name	string	false	none	Offer name
paused	boolean	true	none	none
status	string	true	none	none
tracking_url	string	true	none	none
payouts	[Payout]	true	none	[Payout definition]
offer	Offer	true	none	Offer definition
os	[string]	true	none	List of os

Enumerated Values

Property	Value
status	active
status	paused
status	deleted

LiveOfferResponse

{
  "data": [
    {
      "categories": [
        "Betting"
      ],
      "countries": [
        "DE"
      ],
      "created": "2020-09-29T08:36:26Z",
      "deleted": "2020-09-29T08:36:26Z",
      "description": "Description of the offer",
      "id": 123456,
      "name": "Join Now - 50EUR bonus",
      "paused": false,
      "status": "active",
      "tracking_url": "https://example.com/3St",
      "payouts": [
        {
          "amount": "15.32000000",
          "percentage": null,
          "currency": "EUR",
          "type": "fixed",
          "event_type": "consequuntur_5e8ee02fcea31"
        }
      ],
      "offer": {
        "id": 1,
        "preview_url": "https://example.com/3St"
      },
      "os": [
        "string"
      ]
    }
  ],
  "object": {
    "total": 6,
    "x_ray_id": "29290933d69f32044c2193332af68b61",
    "api_version": "v0.7.3-1385-gf00e4020@2019-08-30T12:48:04+02:00",
    "rq_time": "Request time in seconds",
    "offset": 0,
    "limit": 30,
    "page": 1
  }
}

LiveOfferResponse

Properties

Name	Type	Required	Restrictions	Description
data	[LiveOffer]	true	none	Array of results
object	Meta	false	none	Meta informations.

Name	Type	Required	Restrictions	Description
total	integer	true	none	none
x_ray_id	string	true	none	Request unique identifier
api_version	string	true	none	none
rq_time	string	true	none	none
offset	integer	true	none	Current data offset
limit	integer	true	none	Current limit
page	integer	false	none	Current page

{
  "id": 1,
  "preview_url": "https://example.com/3St"
}

Offer

Properties

Name	Type	Required	Restrictions	Description
id	integer	true	none	Offer ID
preview_url	string¦null	false	none	none

Payout

{
  "amount": "15.32000000",
  "percentage": null,
  "currency": "EUR",
  "type": "fixed",
  "event_type": "consequuntur_5e8ee02fcea31"
}

Payout

Properties

Name	Type	Required	Restrictions	Description
amount	string¦null	true	none	Payout amount. Null with type dynamic.
percentage	string¦null	true	none	Decimal format
currency	string	true	none	Currency
type	string	true	none	It can be 'fixed' or 'dynamic'. For fixed types percentage is null, for dynamic amount is null
event_type	string¦null	true	none	Event type

Enumerated Values

Property	Value
type	fixed
type	dynamic

Open Publisher API for Dash services v1.0.0

Authentication

LiveOffers

Get live offers

Parameters

Enumerated Values

Responses

Schemas

LiveOffer

Properties

Enumerated Values

LiveOfferResponse

Properties

Meta

Properties

Offer

Properties

Payout

Properties

Enumerated Values