Baseify Developer Hub

Below you will find comprehensive guides and documentation to help you start working with Baseify as quickly as possible, as well as support if you get stuck. Please post any questions you might have to our support portal.

1.Get Started

1.1.Getting Started with The Baseify Semantic Monetization Platform

Before You Start
Made sure that you conform to the following criteria:

  • You are a software or website publisher, or operate a collection of such properties either directly or have access to them via an exchange
  • There is no adult, pornographic or gambling traffic that you plan to send Baseify
  • It is clear and understood that any deviation from Baseify’s terms and conditions will constitute a material breach and result in immediate termination

Step 1: Apply for An Account

Due to the premium nature of our demand partners, we make sure to vet each and every publisher or network that joins the Baseify platform passes a thorough review.

  1. Review or gallery of solutions to understand what options might be a fit for a collaboration with Baseify, see here.
  2. Navigate to our enroll page and fill out the details that will give us a full understanding of your business and opportunity.
  3. Complete your application by clicking “register”, that action also is the acceptance of the binding contract between your company and Baseify. Make sure to read it here.

Step 2: Review and Notification

After the application form is received in our system, we will take time to review it. We use multiple factors to determine a fit. If we think there is potential, we will reach out for a skype or phone discussion to learn more.

We do not share reasons for rejection, but we do encourage applicants to re-attempt applying after there has been a noticeable change they can report from one application to another.

You will receive your confirmation \ rejection email to the email you applied with.

Step 3: Activation Code

Once you are accepted you will be getting an email that will include code for you to integrate with. The code will already include your CUID which is the publisher identifier each partner receives when they are accepted to the Baseify platform.

Once you have that email you can review the various technical documents in the remainder of this page for next steps to integrate.

1.2.Understanding Baseify's Reporting

Before you start

If you are not familiar with how performance marketing works, we recommend you either appoint someone within your company who is to take point on this integration or review this helpful video.

Reporting Delivery

Each report can be accessed via:

  • A daily email sent to the email you enrolled with
  • Logging into your account using your dashboard credentials

Dimensions of Reporting

The standard dimensions of the daily report include:

  • Date – [yyyy-mm-dd]
  • Publisher – your alphanumeric identifier in the Baseify system
  • Subid – a dynamic parameter in the Baseify code you integrated, can be anything you want up to 16 characters
  • Widget – the Baseify solution that generated that received your traffic
  • GEO – the country from which the traffic was generated
  • Impressions – counting the number of impressions or queries intercepted via Baseify
  • Clicks – the number of accepted clicks by the Baseify system
  • Estimated revenues – Baseify’s estimation of the current value of traffic

Frequency of Reports

Reports are populated daily based off of the confirmed sales and conversions reported to Baseify by our demand partners. Reports go out at 10 AM PST on a daily basis.

Please note, as Baseify depends on 3rd party revenue information reports are often incomplete on a daily basis, especially after and during the weekends or national holidays of various countries. It is best to review reports with the understanding that there will be significant changes after 72 hours.

Timezone

The Baseify database reports information based off of Pacific Standard Time (-08 GMT).

2.Integrating Baseify's Ad Units to Accept Traffic

Baseify provides monetization solutions that allow users to search and shop via engaging ads.

The technology is integrated into a website or browser add-on via JS code injection, API or iframe placement. Once integrated, users can automatically find contextually relevant products on an ever-expanding database of online merchants and offers and experience true semantic search.

Our partners generate revenues every time a user clicks on a result.

Supported countries: https://www.baseify.com/geos

2.1.Shopping Ads for Direct Web Publishers

1. Basics

Current embedding code allows publisher with no programming skills operate with this kind of widget. The code consists of two parts:

spotting tag – defines a place where the widget will be displayed

injection script – does all job of processing and rendering

2. Implementation

WordPress

If you are using WordPress as your main platform to generate content, you may switch to SOURCE CODE mode in article edit to inject the code. It is highly recommended to use HTML banner widget to inject Shopping Ads Widget on your website page

Source Code

If you have HTML coding skills and access to your website source code, you may easy adapt Shopping Ads Widget to look and feel in harmony with your website design. By injecting the code it should be placed as a part of HTML content. Please make sure your website design features will not overlap widget’s frame

If you still have questions please don’t hesitate to contact us

3. Improvement

In nearest future we are going to add more features in customization form, where publisher will be able to manage widget style, size, number of displayed results, use custom templates to display content similar to website look.

2.2.Search Suggest Integration for Website & Add On Publishers

User Story

  1. The user types a query in the search field
  2. User is shown a list of related results, if applicable
  3. Once user clicks on result, they will be redirected to the advertiser page
Search Suggest - step 1

Search Suggest – step 1

Search Suggest - Step 2

Search Suggest – Step 2

Implementation

  1. You will be provided with archive containing required javascript library and cascade styles
  2. Disable previous logic applied to input
  3. Include <script src=js/bs-search.js></script>  in bottom of body
  4. Include <link rel=stylesheet href=css/bs-outer-styles.css>  in head
  5. Script will find the first appearance of input text and attach search-suggest functionality on it

2.3.Visual Search Integration for Software Publishers

User Story

  1. The user browses to an e-commerce website
  2. User views a product image
  3. They are shown related products either by:
    • Mousing over a product image, via the In-Image Button
    • Viewing the filmstrip appended to the product hero image
In Image Button & Modal Box

In Image Button & Modal Box

Hero Image Filmstrip

Hero Image Filmstrip

Implementation

Inject the below dummy JavaScript code on every page:

Parameters

Should be placed in the JavaScript:

  • sid – An optional parameter which allows you to distinguish between different campaigns or groups. To use, replace the string “none” with a new value per each new campaign launched.
  • name – Dynamically populates the user interface attribution, Ads by XXX. Must match the product name of the toolbar or add-on.
  • mail – Dynamically populates the email in the description to match your support email, required for compliance.

3.Integrating Baseify's Monetization APIs for Exchanges and Ad Networks

Baseify’s APIs support multiple use cases that are particularly useful for ad networks and exchanges, these include:

  • Search API, Complete (JSON Response)
  • Smart Redirector
  • Real-Time Bidding (RTB) API

3.1.Ecommerce Product Search API

When querying the Product Search API, you will need to include specific parameters described in the table below. Upon generation of the API requests, you can then extract the necessary data from the JSON document for the purposes of providing your users with a custom presentation.

Base URL

https://search.ocra.info/api/v1/searchApi

Request Structure

kw  – keyword, required
cuid  – Configurator Uniq Id, required. 32 symbols length alphanumeric string being generated in Baseify HQ by configurator tool
widget  – string identifies widget name, required
subid  – campaign name (subId), optional. Up to 12 symbols String identifies custom campaign name
ip  – client IP address, optional. If this parameter is not specified, script will identify it basing on current client data
numItems  – a number of items to be returned by script, optional, default – 15
domain  – referred page domain
url  – full URL of the page, where search being performed. Obligatory in case of &related parameter specified
minPrice
maxPrice
price  – replaces min and maxPrice

Example:

Response structure example:

Empty response example

Error response example

 

3.2.Integration of Smart Redirect for Real Time Bidders or "Waterfalls"

This redirect script allows the publisher to send Baseify a query URL or Keyword. The Query URL will be analyzed for product-related content, using natural language processing, if no quality result will be found Baseify will use the keyword. If the keyword does not return a result from Baseify’s demand, or if there is no keyword the “out” parameter will be fired (ideal for “waterfall” flows).

Request

Method
URL
GET https://search.ocra.info/smr

 

Params
Values
Required
cuid string Yes
subid string No
kw string Yes
source string Yes (if no kw provided)
out string No

cuid  – Publisher unique ID – 32 alphanumeric symbols length string, provided by baseify publishers dashboard

subid  – Additional custom id, performs additional tracking of campaigns. 1 to 32 alphanumeric + dash + underscore symbols  string, may accept any value

kw  – Search request. Should be URL-encoded. If source URL is not specified or contain no prospective data, kw value will be used as search query

source  – URL of the page where user being sent from. Should be URL-encoded

out  – destination URL where the user will be redirected if the script will not find a related advertisement. Should be URL-encoded

Response

HTTP Status
Response
302 Location to advertisement page or out URL
204 No Content: In case if there is nowhere to redirect
500 Request processing error

Example

https://search.ocra.info/smr?cuid=4f45a87fd9d198a1a0e493a544c67b1c&subid=AUG-17&kw=SanDisk+32GB&source=https%3A%2F%2Fwww.amazon.com%2Fgp%2Fproduct%2FB0143RT8OY%2Fref%3Ds9_acsd_zgift_hd_bw_birY_c_x_2_w%3Fpf_rd_m%3DATVPDKIKX0DER%26pf_rd_s%3Dmerchandised-search-11%26pf_rd_r%3DFMB2BND3ZWK58KDH2K65%26pf_rd_t%3D101%26pf_rd_p%3Dfcb4f536-e749-5c31-91f7-ff7336983901%26pf_rd_i%3D172456&out=http%3A%2F%2Fmyb.ack%2Flocation 

4.Integrate Baseify's Reporting API

Request format

GEThttp://publishers.baseify.com/api/stats.php?period[0]=YYYY-DD-MM&period[1]=YYYY-MM-DD 

Header – Authorization: Basic HASHDATA

Hash data is unique per publisher and it is available on API page in publishers dashboard: http://publishers.baseify.com/api.php

undefined

Response format

JSON in case of failure:

JSON in case of success:

 

Suggest Edit