If you have any question left, please drop a note with the discussion link of this page.
Applications
From Wiki.zanox.com
While zanox Web Services provides all APIs to do innovative solutions to monetize and analyze traffic, zanox Application Store provides a way to list your Applications in our public directory.
This article describes how to integrate three kinds of applications:
- Widgets
- Tools & Software
- Services offered by 3rd Party
Contents |
Widgets
Hello World Widget Template
You can implement a widget using HTML & Java Script and Copy&Paste your code in the proper input field of the zanox Application Store.
You can start using the following template:
<h1>Hello <span id="name">World</span>!</h1> <script type="text/javascript" charset="utf-8"> //<![CDATA[ var my_app_id = 'AAAAAAAAAAAA'; // to be replaced with your own zanox Application ID zanox.setCallback(my_app_id, myStartFunction); function myStartFunction(options) { var my_connect_id = options.connect_id_developer; var publisher_connect_id = options.connect_id_publisher; /* check if publisher sent some options to our app */ if(options.app_options) { if(options.app_options.company && options.app_options.company!="") { var company = options.app_options.company; } if(options.app_options.product && options.app_options.product!="") { var product = options.app_options.product; } $('name').set('text', company + ' ' + product); } } //]]> </script>
Loader Script
Integration Code
Widgets are wrapped in Application Store-generated zanox integration code, HTML which allows you to pass the ConnectID and default values (e.g. the size of the widget or CSS to adapt the widget's layout to the publisher space) to a loader script, which in turn calls your widget. Publishers copy the integration code into their advertising space to render the widgets. The loader script gives zanox control of widgets provided via the Application Store and ensures widgets are loaded correctly.
The integration code and call to the loader script appear as follows:
<div class="zx_adslot" id="3B63B554EE7A9E3D9A35"> <script src="http://zbox.zanox.com/scripts/zanox.js" type="text/javascript" charset="utf-8"></script> <script type="text/javascript" charset="utf-8"> zanox.adslot({ 'adslot_id':'C98AF71486881703E63C', 'adslot_width':'218', 'adslot_height':'572', 'app_options': { 'company':'zanox', 'product':'Application Store' } }); </script> </div>
This code is generated for you by the Application Store and appears under the tab Integration code. If you are the developer, the value for 'adslot_id' is your ConnectID. If you are a user who has bought the widget in the Application Store, the 'adslot_id' contains a ConnectIDthat associates you with this application.
Note that the ConnectID is the mechanism by which the widget on behalf of the publisher retrieves tracking links and other data used by your widget. As a security mechanism, publishers have control over which user resources can be accessed using their ConnectID for the application. For more information, please see Zanox Rights Management.
See also: Authentication mechanisms via the zanox Web Services and API Documentation
Examples
- Retrieve products via contextual product search and use the connectID provided to you by the loader to retrieve the tracking links of the user of your widget.
- Retrieve a specific admedia on behalf of a publisher and use the connectID you by the loader to retrieve the tracking links of the user of your widget.
Commission Sharing
In case you are building monetization widgets for your customers you have to use our zanox Connect to be able to retrieve the proper zanox tracking links in order to share the revenues between yourself and the user of your widget.
Get more details on the possible revenue share concept via zanox.
In the future this loader script will also take care of implementing the traffic sharing mechanism. Based on the widget settings it passes randomly your own connectID or the users connectID.
Tools and Software
Tools and software offered via our application store must use our zanox Connect OAuth Protocol when they need access to private data of our customers.
If you are creating a tool and software you will need to set up a landing page where users can download the software and documentation.
This landing page must be connected to zanox using zanox Connect. This landing page must be integrated in 2 ways:
- Retrieve your user's credentials via the received token and with your credentials. Note: You can use yours and their credential to implement solutions in traffic sharing.
- Allow authentication from your site via zanox.
Software as a Service
UI Integration
If you are providing a software as a service you will need to set up a landing page where users can download the software and documentation or where they can use your service.
This landing page must be connected to zanox using zanox Connect. This landing page must be integrated in 2 ways:
- Retrieve your user's credentials via the received token and with your credentials. Note: You can use yours and their credential to implement solutions in traffic sharing.
- Allow authentication from your site via zanox.
Additional Links
- Get your zanox Web Services authentication credentials
- Try out one of our Tutorials
- Build and monetize your application
