Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

UniqueId

Optional Parameters

---

Properties

Name	Type	Description
uniqueId	String	A unique ID to add to the tracking link.
uniqueId2	String	A unique ID to add to the tracking link.
uniqueId3	String	A unique ID to add to the tracking link.
uniqueId4	String	A unique ID to add to the tracking link.

Remarks

One or more unique ID values can be added to the tracking URL using the "uniqueId", "uniqueId2", "uniqueId3", and "uniqueId4" parameters

JSON XML

Example

Request

GET https://api.commissionfactory.com/V1/Affiliate/Banners/1?apiKey=ABC123&uniqueId=AAAAA&uniqueId2=BBBBB&uniqueId3=CCCCC&uniqueId4=DDDDD

Response

{
    "Id": 1,
    "DateCreated": "2000-01-01T00:00:00.000",
    "DateModified": "2000-01-01T00:00:00.000",
    "MerchantId": 1,
    "MerchantName": "Example Pty Ltd",
    "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
    "GroupName": " Default Group",
    "Name": "Banner 1",
    "TargetUrl": "https://www.example.com/deep/link",
    "Size": "Full Banner",
    "Width": 468,
    "Height": 60,
    "ImageUrl": "https://t.cfjump.com/a/1/1",
    "AltText": "Example Pty Ltd Banner",
    "TrackingUrl": "https://t.cfjump.com/0/b/1?UniqueId=AAAAA&UniqueId2=BBBBB&UniqueId3=CCCCC&UniqueId4=DDDDD",
    "TrackingCode": "<a href=\"https://t.cfjump.com/0/b/1?UniqueId=AAAAA&UniqueId2=BBBBB&UniqueId3=CCCCC&UniqueId4=DDDDD" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\"><img style=\"border: none; vertical-align: middle;\" alt=\"Example Pty Ltd Banner\" referrerpolicy=\"no-referrer-when-downgrade\" src=\"https://t.cfjump.com/a/1/1\" /></a>"
}

<Banner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Id>1</Id>
    <DateCreated>2000-01-01T00:00:00.000</DateCreated>
    <DateModified>2000-01-01T00:00:00.000</DateModified>
    <MerchantId>1</MerchantId>
    <MerchantName>Example Pty Ltd</MerchantName>
    <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
    <GroupName> Default Group</GroupName>
    <Name>Banner 1</Name>
    <TargetUrl>https://www.example.com/</TargetUrl>
    <Size>Full Banner</Size>
    <Width>468</Width>
    <Height>60</Height>
    <ImageUrl>https://t.cfjump.com/a/1/1</ImageUrl>
    <AltText>Example Pty Ltd Banner</AltText>
    <ExpiryDate>2000-01-01T00:00:00.000</ExpiryDate>
    <TrackingUrl>https://t.cfjump.com/0/b/1?UniqueId=AAAAA&UniqueId2=BBBBB&UniqueId3=CCCCC&UniqueId4=DDDDD</TrackingUrl>
    <TrackingCode>&lt;a href="https://t.cfjump.com/0/b/1?UniqueId=AAAAA&UniqueId2=BBBBB&UniqueId3=CCCCC&UniqueId4=DDDDD" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"&gt;&lt;img style="border: none; vertical-align: middle;" alt="Example Pty Ltd Banner" referrerpolicy="no-referrer-when-downgrade" src="https://t.cfjump.com/a/1/1" /&gt;&lt;/a&gt;</TrackingCode>
</Banner>

Related Links

• GET Banners/[id] Function
• GET Coupons/[id] Function
• GET DynamicTools/[id] Function
• GET Merchants/[id] Function
• GET Promotions/[id] Function
• GET Videos/[id] Function