Publisher Integration
API Reference
Get Promotion Links

Basic Information

  • SERVICE_NAME: linkbest.service.links.post

  • Request Method: POST

Request Header

Header ParameterRequiredValueDescription
Content-TypeYesapplication/json

Common Parameters

Parameter NameRequiredExampleDescription
AppKeyYes2312521Website application AppKey
TimestampYes1596592757Second-level timestamp
ServiceYeslinkbest.service.links.postInterface service name
SignYes5D17CCCD5B29F98171D6D0D43136B366Signature

Interface Parameters

NameTypeRequiredDescription
UrlstringOptionalURL to be converted, either ProgramId, ItemId, or Url must be provided
ProgramIdstringOptionalProgram ID, either Url, ProgramId, or ItemId must be provided
ItemIdstringOptionalItem ID
WebsiteIdstringYesPromotion position ID
OriginalstringOptionalWhether the original merchant link is needed
ExtobjectOptionalExtended parameters
└─ CouponstringOptionalCoupon
└─ SubIdstringOptionalYour sub-channel identifier
└─ JsnumberOptionalWhether JS redirection is needed. 1: JS redirection, 0: 302 redirection. Default is 1 if not provided

Request Example

{
    "Url": "string",
    "ProgramId": "string",
    "ItemId": "string",
    "WebsiteId": "string",
    "Original": "string",
    "Ext": {
        "Coupon": "string",
        "SubId": "string",
        "Js": 0
    }
}

Response Parameters

NameTypeRequiredDefaultDescriptionOther Information
StatusintOptionalStatus code
DataobjectOptionalData object
└─ WapobjectOptionalWAP-related information
├─ UrlstringOptionalWAP long URL
├─ CodestringOptionalTaokouling (part of the links may have)
├─ ShopCouponstringOptionalShop coupon
├─ OriginalLinkstringOptionalMerchant original link
└─ ShortUrlstringOptionalBuilt-in short URL
└─ PcobjectOptionalPC-related information
├─ UrlstringOptionalPC long URL
├─ CodestringOptionalTaokouling (part of the links may have)
├─ ShopCouponstringOptionalShop coupon
├─ OriginalLinkstringOptionalMerchant original link
└─ ShortUrlstringOptionalBuilt-in short URL
└─ WxappobjectOptionalWeChat Mini Program-related information
├─ WxPathstringOptionalWeChat Mini Program page path
├─ WxQrcodestringOptionalWeChat QR code
├─ WxGhidstringOptionalWeChat account original ID
└─ WxAppidstringOptionalWeChat Mini Program App ID
└─ LiveRoomobjectOptionalLive room-related information
└─ CodestringOptionalLive room code
MessagestringOptionalError message

Response Example

{
    "Status": "int",
    "Data": {
        "Wap": {
            "Url": "string",
            "Code": "string",
            "ShopCoupon": "string",
            "OriginalLink": "string",
            "ShortUrl": "string"
        },
        "Pc": {
            "Url": "string",
            "Code": "string",
            "ShopCoupon": "string",
            "OriginalLink": "string",
            "ShortUrl": "string"
        },
        "Wxapp": {
            "WxPath": "string",
            "WxQrcode": "string",
            "WxGhid": "string",
            "WxAppid": "string"
        },
        "LiveRoom": {
            "Code": "string"
        }
    },
    "Message": "string"
}