Velgid API 3.0

Za pomocą Velgid API w prosty i szybki sposób pobierzesz najważniejsze dane ze swojego konta Wydawcy. Poniżej znajdziesz najnowsze materiały i informację na temat integracji z platformą afiliacyjną Velgid.


1. Podstawowe informacje

Velgid API umożliwia Ci pobranie bezpośrednio z serwerów sieci afiliacyjnej Velgid różnych informacji. Dostęp do API można uzyskać za pomocą protokołu REST API. Udostępniamy szereg funkcji umożliwiających integrację z platformą Velgid, między innymi będziesz mógł:

  • Uzyskać dostęp do listy programów partnerskich wraz ze statusem partnera
  • Pobierać aktualną listę kodów rabatowych
  • Generować dynamicznie linki partnerskie
  • Pobierać aktualną listę kodów rabatowych dla wybranego programu partnerskiego
  • Pobierać przygotowane słowniki dla statusów w programie, kategorii programu partnerskiego, rodzajów promocji oraz kodów rabatowych
  • Pobierać aktualną listę wygenerowanych przez Ciebie transakcji w modelu CPS
  • Pobierać aktualną listę wygenerowanych przez Ciebie leadów w modelu CPL
  • Zautomatyzować proces integracji platformy Velgid z Twoim serwisem

Dane udostępniane są w czasie rzeczywistym, dzięki czemu będziesz miał zawsze aktualny wgląd w najnowsze informację ze swojego konta Wydawcy. Obsługujemy dwa formaty zwracanych danych - JSON oraz XML.

Cors

Domena api.velgid.com posiada włączoną obsługę CORS, co oznacza, że można użyć po stronie klienta XMLHttpRequest bez jakichkolwiek problemów z bezpieczeństwem między domenami. Poniżej przykład użycia XMLHttpRequest:

 var http_request = new XMLHttpRequest();
 var url = "http://serwer.pl/to/jest/tylko/test"; // adres z danymi w formacie JSON
 // pobierz dane w formacie JSON z serwera
 http_request.onreadystatechange = handle_json;
 http_request.open("GET", url);
 http_request.send(null);
 function handle_json() {
        if (http_request.readyState == 4) {
                if (http_request.status == 200) {
                        var json_data = http_request.responseText; // pobranie tekstu
                        var the_object = eval("("+json_data+")");  // zamiana tekstu na obiekt JSON
                } else {
                        alert('Wystąpił problem z wybranym adresem URL.');
                }
                http_request = null;
        }
 }

2. Autoryzacja

Aby móc korzystać z Velgid API musisz posiadać konto Wydawcy lub Reklamodawcy w sieci Velgid. Po rejestracji uzyskasz dostęp do panelu, w którym będziesz mógł wygenerować klucz autoryzacji. Jest to Twój unikalny klucz, który zapewni Ci możliwość korzystania z funkcjonalności API.

W celu dostępu do wybanej metody API należy w nagłówku dla requesta dodać Authorization Token. Nagłówek ten musi być dodany przed wywołaniem dowolnej metody w API. Poniżej przykład nagłówka.

GET /api/voucher HTTP/1.1
Host: api.velgid.com
Authorization: Token A933468D5-B83E1-4231-846A-2A9A2229969EF2
Cache-Control: no-cache

Przykład dodania nagłówka HTTP w języku PHP dla tokena autoryzacji A933468D5-B83E1-4231-846A-2A9A2229969EF2

setRequestUrl('http://api.velgid.com/api/voucher');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString(array(
  'format' => 'xml'
)));
$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'authorization' => 'Token A933468D5-B83E1-4231-846A-2A9A2229969EF2'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
?>

Powyższy przykład dla języka JavaScript

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("GET", "http://api.velgid.com/api/voucher");
xhr.setRequestHeader("authorization", "Token A933468D5-B83E1-4231-846A-2A9A2229969EF2");
xhr.setRequestHeader("cache-control", "no-cache");
xhr.send(data);

Powyższy przykład dla języka C#

var client = new RestClient("http://api.velgid.com/api/voucher");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("authorization", "Token A933468D5-B83E1-4231-846A-2A9A2229969EF2");
IRestResponse response = client.Execute(request);

Powyższy przykład dla języka Ruby

require 'uri'
require 'net/http'
url = URI("http://api.velgid.com/api/voucher")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["authorization"] = 'Token A933468D5-B83E1-4231-846A-2A9A2229969EF2'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body