Kevel API Quickstart

1. Post

Post an ad request to Kevel when you need a decision made (no JavaScript tags needed).

curl -H 'Content-Type:application/json' \
  -X POST \
  -d '{"placements":[{
  "divName":"div1",
  "networkId":23,
  "siteId":667480,
  "adTypes":[5]}],
  "user":{"key":"abc"}}' \
  \
  https://e-23.adzerk.net/api/v2

2. Parse

Parse the JSON response from Kevel that contains info and tracking links for the winning ad.

{ "user": { "key": "abc" },
  "decisions": {
    "div1": {
      "adID": 1234567,
      "creativeID": 7654321,
      "flightID": 9876543,
      "campaignID": 3456789,
      "clickURL": "https://e-123.kevel.com...",
      "imageURL": "https://e-123.kevel.com...",
      "height": 250,
      "width": 300,
      ...

3. Place

Place the content wherever you want, such as your site, app, OOH digital property, etc.

EXECUTABLE CODE SAMPLES

Test out our APIs today

No API key needed!

Test in JSFiddle

Python
HTML/JS
Java
Javascript
Ruby
Clojure
cURL
import adzerk_decision_sdk

# Demo network, site, and ad type IDs; find your own via the Kevel UI!
client = adzerk_decision_sdk.Client(23, site_id=667480)

request = {
  "placements": [{"adTypes": [5]}],
  "user": {"key": "abc"},
  "keywords": ["keyword1", "keyword2"],
}

response = client.decisions.get(request)
print(response)
&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot; &quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;
&lt;html&gt;
  &lt;head&gt;
    &lt;title&gt;Kevel Decision API - JavaScript Request&lt;/title&gt;
    &lt;script type=&quot;text/javascript&quot; src=&quot;https://unpkg.com/@adzerk/decision-sdk/dist/adzerk-decision-sdk.js&quot;&gt;&lt;/script&gt;
    &lt;script type=&quot;text/javascript&quot; src=&quot;https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js&quot;&gt;&lt;/script&gt;
    &lt;script type=&quot;text/javascript&quot;&gt;
      requestNativeAd = function() {
        // Demo network, site, and ad type IDs; find your own via the Kevel UI!
        let client = new AdzerkDecisionSdk.Client({
          networkId: 23,
          siteId: 667480
        });

        let request = {
          placements: [{
            adTypes: [5]
          }]
        };

        client.decisions.get(request).then(response =&gt; {
          let decision = response.decisions.div0[0];

          // Inject ad contents into page
          $(&quot;#div0&quot;).replaceWith(decision.contents[0].body);
          $(&quot;#response&quot;).text(JSON.stringify(response));
          $(&quot;#clickUrl&quot;).text(decision.clickUrl);

          // Record the impression
          client.pixels.fire({
            url: decision.impressionUrl
          });

        }).catch(error =&gt; {
          console.log(&quot;ERROR!&quot;, error.toString());
        });
      };
    &lt;/script&gt;
  &lt;/head&gt;

  &lt;body&gt;
    &lt;h1&gt;Kevel Native Ad Request&lt;/h1&gt;

    &lt;p&gt;Press the button to make an ad request, record the impression, and display both the internal JSON and HTML payload of the response. The response includes data like Impression URL, Click URL, Campaign ID, Metadata, and more. (Note: May not work if you're using an ad blocker).&lt;/p&gt;

    &lt;button type=&quot;button&quot; onclick=&quot;requestNativeAd()&quot;&gt;Request Ad&lt;/button&gt;

    &lt;hr /&gt;

    &lt;h4&gt;Image:&lt;/h4&gt;
    &lt;div id=&quot;div0&quot;&gt;
      &lt;code&gt;(Nothing yet; please click the button!)&lt;/code&gt;
    &lt;/div&gt;

    &lt;h4&gt;JSON Response:&lt;/h4&gt;
    &lt;code id=&quot;response&quot;&gt;(Nothing yet; please click the button!)&lt;/code&gt;

    &lt;h4&gt;Click URL:&lt;/h4&gt;
    &lt;code id=&quot;clickUrl&quot;&gt;(Nothing yet; please click the button!)&lt;/code&gt;
  &lt;/body&gt;
&lt;/html&gt;
package com.adzerk.examples;

import java.util.*;
import com.adzerk.sdk.*;
import com.adzerk.sdk.generated.ApiException;
import com.adzerk.sdk.generated.model.*;
import com.adzerk.sdk.model.DecisionResponse;

public class FetchAds {
  public static void main(String[] args) throws ApiException {
    // Demo network, site, and ad type IDs; find your own via the Kevel UI!
    Client client = new Client(new ClientOptions(23).siteId(667480));
    Placement placement = new Placement().adTypes(Arrays.asList(5));
    User user = new User().key("abc");

    DecisionRequest request = new DecisionRequest()
      .placements(Arrays.asList(placement))
      .keywords(Arrays.asList("keyword1", "keyword2"))
      .user(user);

    DecisionResponse response = client.decisions().get(request);
    System.out.println(response.toString());
  }
}
import { Client } from "@adzerk/decision-sdk";

// Demo network, site, and ad type IDs; find your own via the Kevel UI!
let client = new Client({ networkId: 23, siteId: 667480 });

let request = {
  placements: [{ adTypes: [5] }],
  user: { key: "abc" },
  keywords: ["keyword1", "keyword2"]
};

client.decisions.get(request).then(response => {
  console.dir(response, { depth: null });
});
require "adzerk_decision_sdk"

# Demo network, site, and ad type IDs; find your own via the Kevel UI!
client = AdzerkDecisionSdk::Client.new(network_id: 23, site_id: 667480)

request = {
  placements: [{ adTypes: [5] }],
  user: { key: "abc" },
  keywords: ["keyword1", "keyword2"],
}

pp client.decisions.get(request)
(ns example-ad-request
  (:import (com.adzerk.sdk Client ClientOptions)
           (com.adzerk.sdk.generated.model DecisionRequest Placement User)))

(defn -main []
  ; Demo network, site, and ad type IDs; find your own via the Kevel UI!
  (let [client (Client. (doto (ClientOptions. (int 23)) (.siteId (int 667480))))
        request (doto (DecisionRequest.)
                      (.placements [(doto (Placement.) (.adTypes [5]))])
                      (.keywords ["keyword1" "keyword2"])
                      (.user (doto (User.) (.key "abc"))))
        response (-> client (.decisions) (.get request))]

    (println response)))
curl -H 'Content-Type:application/json' \
  -X POST \
  -d '{"placements":[{
  "divName":"div1",
  "networkId":23,
  "siteId":667480,
  "adTypes":[5]}],
  "user":{"key":"abc"}}' \
  \
  https://e-23.adzerk.net/api/v2