Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Video Type

Represents a single video.

---

Properties

Name	Type	Description
Id	Integer	The ID of the video.
DateCreated	DateTime	The date and time that the video was created.
DateModified	DateTime	The date and time that the video was last modified.
MerchantId	Integer	The ID of the merchant who created this video.
MerchantName	String	The campaign name of the merchant who created this video.
MerchantAvatarUrl	Url	The address of the avatar image of the merchant who created this video.
Name	String	The name of the video.
VideoUrl	Url	The address of the video on YouTube or Vimeo.
ButtonColour	String	The colour of the video overlay button.
ButtonText	String	The text of the video overlay button.
HoverText	String	The text that appears when the cursor hovers over the overlay button.
TargetUrl	Url	The address of the landing page on the merchant's website.
EmbedUrl	Url	The address of this video, to be used in an IFRAME or popup window.
EmbedCode	String	Fully formatted HTML code that can be embedded directly on an affiliate website.

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",
    "Name": "Video 1",
    "VideoUrl": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "ButtonColour": "Red",
    "ButtonText": "Click Here",
    "HoverText": "Click here to buy now",
    "TargetUrl": "https://www.example.com/",
    "EmbedUrl": "https://c.cfjump.com/Videos/0/1/",
    "EmbedCode": "<iframe style=\"border: none; height: 324px; width: 400px;\" allowtransparency=\"true\" border=\"0\" frameborder=\"0\" src=\"https://c.cfjump.com/Videos/0/1/\"></iframe>"
}

<Video 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>
    <Name>Video 1</Name>
    <VideoUrl>https://www.youtube.com/watch?v=dQw4w9WgXcQ</VideoUrl>
    <ButtonColour>Red</ButtonColour>
    <ButtonText>Click Here</ButtonText>
    <HoverText>Click here to buy now</HoverText>
    <TargetUrl>https://www.example.com/</TargetUrl>
    <EmbedUrl>https://c.cfjump.com/Videos/0/1/</EmbedUrl>
    <EmbedCode>&lt;iframe style="border: none; height: 324px; width: 400px;" allowtransparency="true" border="0" frameborder="0" src="https://c.cfjump.com/Videos/0/1/"&gt;&lt;/iframe&gt;</EmbedCode>
</Video>

Related Links

• GET Videos Function
• GET Videos/[id] Function
• VideoArray Type