# \[EN] Linkrall Offline API for Publisher v3.7 {% hint style="info" %} Linkrall is a **lower-cost Traffic Tracking Platform** with multi-dimensional reports, optimization solutions and easy- using panels. For more information, please visit：[http://www.linkrall.com](http://www.linkrall.com/)​ {% endhint %} ### 0. Update History **\[2020/08/20]** v3.6: For iOS14 new policy，added three click URL parameters：ip, lang, ua **\[2021/01/11]** v3.7: Added two response parameters: click\_cap, cap\_timezone ### 1. Introduction Linkrall offline API is designed for the publishers to retrieve offers from the server. This document describes how publishers request Linkrall ads via the API call. #### Notice * The API is accessible by HTTP GET request and returns data in JSON format. * This is an OFFLINE API which should NOT be called from end-user devices. * The API is recommended to be requested every 10-15 minutes. * The IDFA/GAID MUST be appended to the click URL if the parameter 'deviceid\_required'=1 ### 2. API Request Method #### Request URL: http\://\[*Advertiser Domain*]/v3/api\_v3?key=\[*API key*] #### Request Method: GET #### Request Parameters | Parameters | Description | Required | | ---------- | ----------------------------------------- | :------: | | key | The API key given by your Account Manager | Yes | | limit | The page size, default 3000 | No | | page | The page number | No | | os | Device OS, value ios/android | No | #### Response parameters | Parameter | Description | | ------------------ | --------------------------------------------------------------------------------------------- | | message | The message of API request | | data | Array of Offers | | id | Offer id | | name | Offer title | | payout | Offer payout | | currency |

Payment currency

Value: USD

| | countires |

List of countries, multiple countries are separated by comma

Value: US,IN,JP

| | click\_url | Offer click URL | | preview\_link | Offer preview URL(GP/Appstore) | | package | Offer package name | | description | Offer description, including KPI | | device |

Device type

Value: all/mobile/tablet

| | os |

Device OS

Value: ios/android

| | min\_osv |

The minimum OS version

0 stands for no limited

| | incentive |

0: non-incentive offer

1: incentive offer

| | deviceid\_required |

Whether IDFA/GAID is required.

0: No requirement

1: IDFA/GAID is a must.

| | icon | Icon URL | | cap | Offer daily conversion cap, 99999 means unlimited. | | click\_cap | Offer daily click cap, -1 means unlimited. | | cap\_timezone |

Cap Timezone

eg. 8 means GMT+8

| | creatives | Array of creative | | creatives.type |

Type of creative

Value: image/zip

| | creatives.size | File size(KB) of creative | | creatives.width | Width of an image | | creatives.height | Height of an image | | creatives.url | URL of creative | | video | Array of video | | video.size | File size(KB) of video | | video.url | URL of video | | status |

Offer status, paused offers will be removed from API feed.

Value: active

| | convert\_type | Value: CPI/CPE/CPS | | page | Page number | | totalData | The total number of offers | | limit | Page size | #### Response Example ``` { "message": "Success", "data": [ { "id": 12345, "name": "Lazada IN", "payout": "2.66", "currency": "USD", "countries": "IN", "click_url":"http://xxx.com/clk.php?offer_id=1&aff_id=123", "preview_link": "https://play.google.com/store/apps/details?id=com.lazada.in", "package": "com.lazada.in", "description": "", "device": "all", "os": "android", "min_osv": "0", "incentive": 0, "deviceid_required": 0, "icon": "http://xxx.com/creatives/icon?id=12345", "cap": 99999, "click_cap": -1, "cap_timezone": 8, "creatives": [{ "type": "image", "size": "37", "width": "728", "height": "90", "url": "http://xxx.com/creative/1.jpg" }], "video": [{ "url": "http://xxx.com/creative/1.mp4", "size": "741" }], "status": "active", "convert_type": "CPI" } ], "page": 1, "totalData": 6, "limit": 1 } ``` ### 3. Click URL Parameters | Parameter | Description | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | aff\_sub1 | Your click id | | aff\_sub2 | User-defined parameter | | aff\_sub3 | User-defined parameter | | aff\_sub4 | User-defined parameter | | aff\_sub5 | User-defined parameter | | source\_id | Your source id | | google\_aid | Google Advertising ID | | ios\_idfa | IOS Identifier for Advertising | | app\_name | Your app name | | pkg\_name | Your package name | | ip |

Device IP, only for iOS Version>14.0

Value: 192.168.0.0

| | lang |

Device Language, only for iOS Version>14.0

Value: en-US

| | ua |

User Agent, need to be URL encoded, only for iOS Version>14.0

Value: Mozilla%2F5.0%20(iPhone%3B%20CPU%20iPhone%20OS%2

11\_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F604.1.38%20

(KHTML%2C%20like%20Gecko)%20Version%2F11.0%20Mobile%2F1

5A372%20Safari%2F604.1

| #### Click URL Example http\://\[Advertiser Domain]/clk.php?offer\_id=12345\&aff\_id=123\&aff\_sub1=\[CLICK ID]\&source\_id=\[SOURCE ID]\&google\_aid=\[GAID]\&ios\_idfa=\[IDFA]\&app\_name=\[APP NAME]\&ip=\[CLIENT IP]\&lang=\[CLIENT LANGUAGE]\&ua=\[CLIENT UA] ### 4. Postback Parameters | Macro | Description | | --------------- | ------------------------------ | | {aff\_sub1} | Click ID | | {aff\_sub2} | User-defined Parameter | | {aff\_sub3} | User-defined Parameter | | {aff\_sub4} | User-defined Parameter | | {aff\_sub5} | User-defined Parameter | | {source\_id} | Source ID | | {google\_aid} | Google Advertising ID | | {ios\_idfa} | IOS Identifier for Advertising | | {app\_name} | App Name | | {pkg\_name} | Package Name | | {payout} | Conversion Price | | {offer\_id} | Offer ID | | {country\_code} | Country Code (eg. US) | | {click\_ip} | Client Click IP | | {click\_time} | Client Click Time | | {conv\_ip} | Conversion IP | | {conv\_time} | Conversion Time |