Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

BannerArray Type

Represents zero or more banners.


Array Elements

Type Description
Banner Represents a single banner.

JSON XML

Example

[
    {
        "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/",
        "Size": "Full Banner",
        "Width": 468,
        "Height": 60,
        "ImageUrl": "https://t.cfjump.com/a/1/1",
        "AltText": "Example Pty Ltd Banner",
        "ExpiryDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/b/1",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/b/1\" rel=\"noindex,nofollow\"><img style=\"border: none; vertical-align: middle;\" alt=\"Example Pty Ltd Banner\" src=\"https://t.cfjump.com/a/1/1\" /></a>"
    },
    {
        "Id": 2,
        "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 2",
        "TargetUrl": "https://www.example.com/",
        "Size": "Full Banner",
        "Width": 468,
        "Height": 60,
        "ImageUrl": "https://t.cfjump.com/a/1/2",
        "AltText": "Example Pty Ltd Banner",
        "ExpiryDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/b/2",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/b/2\" rel=\"noindex,nofollow\"><img style=\"border: none; vertical-align: middle;\" alt=\"Example Pty Ltd Banner\" src=\"https://t.cfjump.com/a/1/2\" /></a>"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "MerchantId": 3,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "GroupName": " Default Group",
        "Name": "Banner 3",
        "TargetUrl": "https://www.example.com/",
        "Size": "Full Banner",
        "Width": 468,
        "Height": 60,
        "ImageUrl": "https://t.cfjump.com/a/1/3",
        "AltText": "Example Pty Ltd Banner",
        "ExpiryDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/b/3",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/b/3\" rel=\"noindex,nofollow\"><img style=\"border: none; vertical-align: middle;\" alt=\"Example Pty Ltd Banner\" src=\"https://t.cfjump.com/a/1/3\" /></a>"
    }
]
<BannerArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Banner>
        <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>null</ExpiryDate>
        <TrackingUrl>https://t.cfjump.com/0/b/1</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/b/1" rel="noindex,nofollow"&gt;&lt;img style="border: none; vertical-align: middle;" alt="Example Pty Ltd Banner" src="https://t.cfjump.com/a/1/1" /&gt;&lt;/a&gt;</TrackingCode>
    </Banner>
    <Banner>
        <Id>2</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 2</Name>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Size>Full Banner</Size>
        <Width>468</Width>
        <Height>60</Height>
        <ImageUrl>https://t.cfjump.com/a/1/2</ImageUrl>
        <AltText>Example Pty Ltd Banner</AltText>
        <ExpiryDate>null</ExpiryDate>
        <TrackingUrl>https://t.cfjump.com/0/b/2</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/b/2" rel="noindex,nofollow"&gt;&lt;img style="border: none; vertical-align: middle;" alt="Example Pty Ltd Banner" src="https://t.cfjump.com/a/1/2" /&gt;&lt;/a&gt;</TrackingCode>
    </Banner>
    <Banner>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>3</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <GroupName> Default Group</GroupName>
        <Name>Banner 3</Name>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Size>Full Banner</Size>
        <Width>468</Width>
        <Height>60</Height>
        <ImageUrl>https://t.cfjump.com/a/1/3</ImageUrl>
        <AltText>Example Pty Ltd Banner</AltText>
        <ExpiryDate>null</ExpiryDate>
        <TrackingUrl>https://t.cfjump.com/0/b/3</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/b/3" rel="noindex,nofollow"&gt;&lt;img style="border: none; vertical-align: middle;" alt="Example Pty Ltd Banner" src="https://t.cfjump.com/a/1/3" /&gt;&lt;/a&gt;</TrackingCode>
    </Banner>
</BannerArray>

Related Links