Introduction

The Tappa Quicklinks Unit API you with an optimised set of Brand Quicklinks to use in your App, delivering the optimal revenue for the location.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/9cf861de-7817-4c97-b708-2ed55c397eb4/Screenshot_2019-10-17_at_15.49.31.png

Configuration

Your representative will provide you with one or more campaign identifiers to use when configuring the unit. Configuration of these campaigns determines the set of brands that can be served by the unit, also geo-matching and tuning of the optimisation algorithm.

These campaign identifiers are also used to track revenue generated from the unit and as such you may which to request more than one campaign identifier to differentiate between performance of different units in a page, or across different sites.

Requesting Links

Links are requested by making an HTTP GET request in the following format:

// Where in this example ut6FwmywVbMR4vnNrnLXmy is the campaign identifier

curl -X GET \\
  <https://api>.{hostname}{/multi/ut6FwmywVbMR4vnNrnLXmy \\
  -H 'Accept: */*' \\
  -H 'Accept-Encoding: gzip, deflate' \\
  -H 'Cache-Control: no-cache' \\
  -H 'Connection: keep-alive' \\
  -H 'Host: api.{hostname}' \\
  -H 'cache-control: no-cache'

You will receive a response in the following structure:

{
    "type": "quicklinks",
    "data": [
            {
            "score": 1,
            "id": "3aac8f0fe989f82ae38b79d8745e9f60",
            "uid": "W8",
            "title": "Adobe: Creative, marketing and document management solutions",
            "name": "Adobe: Creative, marketing and document management solutions",
            "shortName": "Adobe",
            "link": "<https://link>.{hostname}/link/r?u=http%3A%2F%2Fwww.adobe.com&zc=W8&client_id=CAENBgMFBAMHCgwIBA4NCA&campaign_id=AQoGCQEBDAENBgIHBAgOBQ&cid=pc&environment=production&zi=11144a32-f179-11e9-9a23-2547d8837e68&qlid=3aac8f0fe989f82ae38b79d8745e9f60",
            "description": "Adobe is changing the world through digital experiences. We help our customers create, deliver and optimize content and applications.",
            "rank": 232,
            "rootDomain": "adobe.com",
            "type": "web",
            "site": "<http://www.adobe.com>",
            "creatives": {
                "logo": "<https://assets.mocha.global/mobicast/image/upload/logo/adobe.com>",
                "favicon": "<https://assets.mocha.global/mobicast/image/upload/favicon/adobe.com/144>",
                "logosqr": "<https://assets.mocha.global/mobicast/image/upload/c_pad,h_48,w_48,q_10/logosqr/adobe.com.png>",
                "logosqr_180": "<https://assets.mocha.global/mobicast/image/upload/c_pad,h_180,w_180,q_90/logosqr/adobe.com.png>"
            }
        },
        {
            "score": 1,
            "id": "47d2e775eb8b9c732931632d7291ba79",
            "uid": "aX",
            "title": "Free People - Women’s Boho Clothing & Bohemian Fashion",
            "name": "Free People - Women’s Boho Clothing & Bohemian Fashion",
            "shortName": "Freepeople.com",
            "link": "<https://link>.{hostname}/link/r?u=http%3A%2F%2Fwww.freepeople.com&zc=aX&client_id=CAENBgMFBAMHCgwIBA4NCA&campaign_id=AQoGCQEBDAENBgIHBAgOBQ&cid=pc&environment=production&zi=11144a30-f179-11e9-9a23-2547d8837e68&qlid=47d2e775eb8b9c732931632d7291ba79",
            "description": "Free People Clothing Boutique - The Official Site for Free People Apparel, Accessories and Shoes. Free Shipping Worldwide - See site for details.",
            "rank": 1899,
            "rootDomain": "freepeople.com",
            "type": "web",
            "site": "<http://www.freepeople.com>",
            "creatives": {
                "logo": "<https://assets.mocha.global/mobicast/image/upload/logo/freepeople.com>",
                "favicon": "<https://assets.mocha.global/mobicast/image/upload/favicon/freepeople.com/144>",
                "logosqr": "<https://assets.mocha.global/mobicast/image/upload/c_pad,h_48,w_48,q_10/logosqr/freepeople.com.png>",
                "logosqr_180": "<https://assets.mocha.global/mobicast/image/upload/c_pad,h_180,w_180,q_90/logosqr/freepeople.com.png>"
            }
        },
        {
            "score": 1,
            "id": "8dbda183c1d2067c04be5492eb5c1679",
            "uid": "Mo",
            "title": "For Life Out Here | Tractor Supply Co.",
            "name": "For Life Out Here | Tractor Supply Co.",
            "shortName": "Tractorsupply.com",
            "link": "<https://link>.{hostname}/link/r?u=http%3A%2F%2Fwww.tractorsupply.com&zc=Mo&client_id=CAENBgMFBAMHCgwIBA4NCA&campaign_id=AQoGCQEBDAENBgIHBAgOBQ&cid=pc&environment=production&zi=11144a31-f179-11e9-9a23-2547d8837e68&qlid=8dbda183c1d2067c04be5492eb5c1679",
            "description": "Tractor Supply Co. is the source for farm supplies, pet and animal feed and supplies, clothing, tools, fencing, and so much more. Buy online and pick up in store is available at most locations. Tractor Supply Co. is your source for the Life Out Here lifestyle!",
            "rank": 536,
            "rootDomain": "tractorsupply.com",
            "type": "web",
            "site": "<http://www.tractorsupply.com>",
            "creatives": {
                "logo": "<https://assets.mocha.global/mobicast/image/upload/logo/tractorsupply.com>",
                "favicon": "<https://assets.mocha.global/mobicast/image/upload/favicon/tractorsupply.com/144>",
                "logosqr": "<https://assets.mocha.global/mobicast/image/upload/c_pad,h_48,w_48,q_10/logosqr/tractorsupply.com.png>",
                "logosqr_180": "<https://assets.mocha.global/mobicast/image/upload/c_pad,h_180,w_180,q_90/logosqr/tractorsupply.com.png>"
            }
        }
    ]
}

The elements of the response are as follows:

Optional Parameters