ACCESSTRADE-Support

Creative APIs

Get Image Creatives

• GET /v1/publishers/me/sites/{siteId}/campaigns/{campaignId}/creatives/image
  • campaignId : a merchant campaign ID
  • siteId : a publisher site ID
• Publisher API Authentication required
• Request : empty
• Response:
  • 200 OK on success

    [
    {
        "id": 1,
        "name": "test",
        "imageUrl": "http://google.com",
        "description": "tteesstt",
        "creatives": [
              {
                  "id": 1704,
                  "width": 250,
                  "height": 250,
                  "imageUrl": "http://ad.accesstrade.co.id/274ad4786c3abca69fa097b85867d9a4/1704_250x250-real-accesstrade.jpg",
                  "imageLink": "<a href="http://click.st-dsbd-id.asean-accesstrade.net/adv.php?rk=0001bc000001" target="_blank"><img src="http://imp.st-dsbd-id.asean-accesstrade.net/img.php?rk=0001bc000001" border="0"/></a>"
              },
              {
                  "id": 1703,
                  "width": 250,
                  "height": 250,
                  "imageUrl": "https://s3-ap-southeast-1.amazonaws.com/images.accesstrade.co.id/274ad4786c3abca69fa097b85867d9a4/1703_at 250x250_20170126041921061.jpg",
                  "imageLink": "<a href="http://click.st-dsbd-id.asean-accesstrade.net/adv.php?rk=0001bb000001" target="_blank"><img src="http://imp.st-dsbd-id.asean-accesstrade.net/img.php?rk=0001bb000001" border="0"/></a>"
              }
        ]
    }
    ]
    

    Get Text Creatives

• GET /v1/publishers/me/sites/{siteId}/campaigns/{campaignId}/creatives/text
  • campaignId : a merchant campaign ID
  • siteId : a publisher site ID
• Publisher API Authentication required
• Request : empty
• Response:
  • 200 OK on success

    [
    {
        "id": 2352,
        "text": "ACCESS TRADE",
        "textLink": "<a href=\"http://click.accesstrade.co.id/adv.php?rk=00000m000002\">www.accesstrade.co.id<img src=\"http://imp.accesstrade.co.id/img.php?rk=00000m000002\" width=\"1\" height=\"1\" border=\"0\" alt=\"\" /></a>"
    },
    {
        "id": 2353,
        "text": "ACCESS TRADEEEE",
        "textLink": "<a href=\"http://click.accesstrade.co.id/adv.php?rk=00000m000002\">www.accesstrade.co.id<img src=\"http://imp.accesstrade.co.id/img.php?rk=00000m000003\" width=\"1\" height=\"1\" border=\"0\" alt=\"\" /></a>"
    }
    ]
    

    Get Quick Link

• GET /v1/publishers/me/sites/{siteId}/campaigns/{campaignId}/creatives/quicklink
  • campaignId : a merchant campaign ID
  • siteId : a publisher site ID
• Publisher API Authentication required
• Request : empty
• Response:
  • 200 OK on success
  • 404 Not Found when no active quick link is found for the campaign, or the given site is not affiliated with the given campaign

    {
    "affiliateLink": "http://click.accesstrade.co.id/adv.php?rk=00000p000003"
    }
    

Get the Accepted URL of Landing Page URL for Creating Custom Creative

• GET /v1/publishers/me/sites/{siteId}/campaigns/{campaignId}/creatives/custom/acceptedurls
  • campaignId: a merchant campaign ID
  • siteId: a publisher site ID
• Publisher API Authentication required
• Response

{
    "landingUrls": [
        {
            "displayValue": "https://shopee.co.id",
            "validationValue": "https://shopee[.]co[.]id[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*"
        },
        {
            "displayValue": "https://mall.shopee.vn",
            "validationValue": "https://mall[.]shopee[.]vn[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*"
        },
        {
            "displayValue": "https://shope.cody.vn",
            "validationValue": "https://shope[.]cody[.]vn[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*"
        },
        {
            "displayValue": "https://*.at.com",
            "validationValue": "https://[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*[.]at[.]com[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*"
        },
        {
            "displayValue": "https://shope.ee",
            "validationValue": "https://shope[.]ee[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*"
        },
        {
            "displayValue": "https://shp.ee/",
            "validationValue": "https://shp[.]ee/[-a-zA-Z0-9+&@*#/%?=~_|!:,.;'()]*"
        }
    ]
    
}

Create Custom Creative

• POST /v1/publishers/me/sites/{siteId}/campaigns/{campaignId}/creatives/custom
  • campaignId: a merchant campaign ID - required
  • siteId: a publisher site ID - required
  • landingUrl: is the target landing page url - required
  • imageUrl: image url of the creative link - not required
  • anchorText: anchor text - not required
  • subIds: subIds parameter you want add to the affiliate link - not required
• Publisher API Authentication required
• Request:

{
  "landingUrl": "https://www.allonline.7eleven.co.th/",
  "imageUrl": "https://www.allonline.7eleven.co.th/media/i/Hero_1200x418-CF-258434-0.webp",
  "anchorText": "",
  "name": "test creative name",
  "subIds": [
    {
      "label": "aid",
      "value": "{aid}",
      "name": "aid"
    },
    {
      "label": "sskey",
      "value": "{sskey}",
      "name": "sskey"
    },
    {
      "label": "uid",
      "value": "{uid}",
      "name": "uid"
    }
  ]
}

• Response:
  • 200 OK

    {
    "totalItems": 1,
    "content": [
        {
            "createdOn": "2025-01-08 11:04:05",
            "id": 659954,
            "name": "test creative name",
            "affiliateLink": "https://atth.me/go/pgaCUwds",
            "imageLink": "<a href=\"https://atth.me/fly/00e582000001\" target=\"_blank\"><img src=\"https://www.allonline.7eleven.co.th/media/i/Hero_1200x418-CF-258434-0.webp\" alt=\"null\" border=\"0\"/><img src=\"https://imp.accesstrade.in.th/img.php?rk=00e582000001\"width=\"1\"height=\"1\"border=\"0\"alt=\"\"/></a>",
            "trackingTemplate": "",
            "finalUrl": "",
            "isGoogleAdsUrlsVisible": false,
            "campaignName": "[WEB] ALLONLINE",
            "subIds": [
                {
                    "name": "aid",
                    "value": "%7Baid%7D"
                },
                {
                    "name": "sskey",
                    "value": "%7Bsskey%7D"
                },
                {
                    "name": "uid",
                    "value": "%7Buid%7D"
                }
            ],
            "siteId": 1,
            "landingUrl": "https://www.allonline.7eleven.co.th/",
            "imageUrl": "https://www.allonline.7eleven.co.th/media/i/Hero_1200x418-CF-258434-0.webp"
        }
    ]
    }