[email protected] | www.winclap.com Winclap Market Publisher API V2.1 - 2017, Aug Version History Version Date Description 1.0 2016, May First Version 2.0 2017, Jan Added all offer information on list endpoints. Added new fields for offer object and reorganized others. This version allows paginated responses. This version allows filtering by parameters. 2.1 2017, Aug Endpoints: /apply and /offers are not necessary. Desired fields: Added new desired fields for offer object. Countries list added. [email protected] | www.winclap.com Introduction Welcome to Winclap’s Market Publisher API. This service will allow you to automate your work and access your account data remotely. Integrating with Winclap’s Market Publisher API is pretty simple, you only need to generate HTTP requests to a determined endpoint, and you will get a JSON response from us. In this document you will find every available endpoint, the parameters you need for each of them, and the method you will have to use to generate the request. Also you will find the format of the answer you will receive, and an example for you to get familiarized with our tech. Supported Endpoints Winclap’s Market Publisher API supports the following endpoints: offers/approved/ - List of offers that you are approved to run offers/<pk>/ - Obtains the offers detail. Access to the API Every Affiliate user that would like to access Winclap’s API will have to go through its Account Manager, who will trigger the process, and provide access from an internal platform. This will generate a unique token that will be later used to authenticate the Affiliate, and the Affiliate will use it to access the API. Every HTTP request will have to contain this parameter, in addition to the id number provided by the Account Manager ( Affiliate ID), to ensure the authentication and authorize the request. Your Account Manager is responsible to generate and provide you with an access token and id number ( Affiliate ID). Token Example 5926ca75-348a-4d03-9d04-6f8c188d3859 Affiliate ID Example 253 Base URL http://api2.winclap.com/market/v2/offers/ [email protected] | www.winclap.com REFERENCES Offer object An offer object represents a campaign that can be passed to an Affiliate. The fields below describes an offer object: Name Type Required Description id integer required Winclap’s platform offer identifier. status integer required Offer status. ( See Status table) name string required Offer name. restrictions string General offer description and restrictions. optional desired type integer required Payout type of the offer. ( See Type table.) incent boolean Whether or not this offer accept incent optional traffic. desired app App optional App information of the CPI offer. ( See App object object.) Required when offer type is 0 ( "CPI"). site Site optional Site information of the CPA offer. ( See Site object object.) Note: Required when offer type is 1 ( "CPA"). [email protected] | www.winclap.com start_date string required Date and time when the offer starts. due_date string optional Date and time when the offer ends. tracking_link string The click tracking URL of the offer. optional desired payout float required Rate to be payed for each conversion. daily_cap integer optional The number of daily capping in conversions. desired pub_blacklist array of optional Array containing publishers id blocked to run strings desired this offer. creatives optional Array containing the info creatives of the array of desired offer. ( See Creative object.) Creative objects countries array of optional Array containing codes of targeted countries strings desired of the offer. ( See countries references) cities array of optional Array containing cities using United Nations strings desired Code for Trade & Transport Locations. [email protected] | www.winclap.com platform integer optional desired The targeted operating system for the offer. ( See platform table) Note: Required when offer type is 0 ( "CPI"). os_versions Array containing the targeted versions of the array of optional operating system depending the field strings desired platform. connection integer optional The targeted connection type of the offer. (See connection table) device integer optional The targeted device type of the offer ( See device table) gender integer The targeted gender of the offer. ( See optional gender table) desired min_age integer The number of minimum age targeted. optional desired max_age integer The number of maximum age targeted. optional desired categories array of optional Array containing the targeted IAB categories. strings desired ( See categories table) [email protected] | www.winclap.com App object An app object represents a store application, where the end user should be redirected. It could be for: ● Android ( Google Play™ Store) ● iOS ( App Store® or iTunes Store®) ● Windows Phone ( Windows Store®) The fields below describes an app object: Name Type Required Description preview_url string required Application store URL. name string required Application name. description string optional Application store description. icon string optional Application icon URL. Site object A site object represents a website where the end user should be redirected. The fields below describes a site object: Name Type Required Description preview_url string required Site URL. icon string optional Site icon URL. [email protected] | www.winclap.com Creative object A creative object represents a image that should be shown to the end user. The fields below describes a creative object: Name Type Required Description id integer required Winclap’s platform creative identifier. name string required Creative name. url string required Creative image downloadable url. mimetype string required Creative image mimetype. format string required Creative dimensions, width by height. API END POINTS offers/approved Example http://api2.winclap.com/market/v2/offers/approved/?token=5926ca75-348a- 4d03 -9d04-6f8c188d3859&affiliate=253 Description List of offers you are approved to run. Method GET [email protected] | www.winclap.com Response Example { "id": 16 , "status": 0 , "name": "FAIRWAY SOLITAIRE - ANDROID", "restrictions": "no adult, no incent, no re-brokering, own creatives need approval", "type": 0 , "incent": false, "app":{ "preview_url": "https://play.google.com/store/apps/details?id=air.com.bigfishgames.fairway reven gegooguniversalf2p&hl=es", "name": "Fairway Solitario Blast", "icon": "https://lh3.googleusercontent.com/oujEzdM6DGWT9eUlJOBtn3uGS4mNxsY kcA NUYtpXkVGaiSv4p84qPbFzCHYeUzLHpSUq" } , "start_date": "2016-12-06T00:00:00Z", "tracking_link": "http://localhost:8002/offers/click/1/16/", "payout": 1 , "daily_cap": 505 , "creatives":[ { "id": 3 , [email protected] | www.winclap.com "name": "Creative #2", "url": "https://winclap-storage-local-ss.s3.amazonaws.com:443/performance- creatives/1 interstitial-1-es.jpg", "mimetype": "image/jpeg", "format": "320x480" } , { "id": 2 , "name": "Creative #1", "url": "https://winclap-storage-local-ss.s3.amazonaws.com:443/performance- creatives/1 Creativo-SagradaFamilia.jpg", "mimetype": "image/jpeg", "format": "320x480" } ] , "countries":[ "AU", "AT", "CN", "FR", "DE", "GR", "IT", "JP", "KR", "MX", "ES", "AE", "GB", [email protected] | www.winclap.com "US" ] , "platform": 0 , "cities": [ "COR" ] , "os_versions": [ "1.1" ] , "connection": 1 , "device": 0 , "gender": 0 , "min_age": 1 , "max_age": 4 , "categories": [ "IAB1" ] } Request Parameters Name Type Required Description countries list of optional Allows you to filter offers by GEO. They string must be passed in ISO 3166-1 alpha-2 country code format. E.g.: &countries=US&countries=UK Default: null [email protected] | www.winclap.com platform integer optional Allows you to filter the offer list by mobile platform Winclap identifies the platforms as follows: Android iOS Windows Phone E.g.: &platform=1 Default: null type integer optional Allows you to filter offers by type, between CPA and CPI. Winclap identifies the types of offers as follows: CPI CPA E.g.: &type=0 Default: null incent boolean optional Allows to differentiate Incent offers from Non Incent. E.g.: &incent=true Default: null min_payout float optional Allows to filter the offers by the minimum payout. E.g.: &min_payout=0.5 Default: null max_payout float optional Allows to filter the offers by the maximum payout. E.g.: &max_payout=6 Default: null [email protected] | www.winclap.com page_size integer optional Number of offers per page. E.g.: &page_size=25 Default: 50 page integer optional Page number. E.g.: &page=2 Default: 1 offers/<pk> Example http://api2.winclap.com/market/v2/offers/1857/?token=5926ca75-348a-4d03- 9d04 -6f8c188d3&affiliate=52 Descriptio n Obtains the offers detail Method GET [email protected] | www.winclap.com Response Example { "id": 16 , "status": 0 , "name": "FAIRWAY SOLITAIRE - ANDROID", "restrictions": "no adult, no incent, no re-brokering, own creatives need approval", "type": 0 , "incent": false, "app":{ "preview_url": "https://play.google.com/store/apps/details?id=air.com.bigfishgames.fairwayr even gegooguniversalf2p&hl=es", "name": "Fairway Solitario Blast", "icon": "https://lh3.googleusercontent.com/oujEzdM6DGWT9eUlJOBtn3uGS4mNxsYkc AN UYtpXkVGaiSv4p84qPbFzCHYeUzLHpSUq" } , "start_date": "2016-12-06T00:00:00Z", "tracking_link": "http://localhost:8002/offers/click/1/16/", "payout": 1 , "daily_cap": 505 , "creatives":[ { [email protected] | www.winclap.com "id": 3 , "name": "Creative #2", "url": "https://winclap-storage-local-ss.s3.amazonaws.com:443/performance- creatives/1/ interstitial-1-es.jpg",