Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Videos Function

Retrieves an array of videos, optionally filtered by one or more properties.


Syntax

GET https://api.commissionfactory.com/V1/Merchant/Videos?apiKey=[apiKey]&buttonColour=[buttonColour]

Parameters

Name Type Description
apiKey
Required
String A valid API key that represents a merchant account.
buttonColour
Optional
String If specified, filters results by button colour.

Return Value

Type Description
VideoArray Represents zero or more videos.

Errors

Error Description
400 Bad Request One or more parameters could not be parsed correctly.
401 Unauthorised The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
500 Internal Server Error An unexpected error occured while processing your request.
503 Service Unavailable The API call rate limit for the user account has been exceeded.
NOTE: As of 2019-02-01, the response from the server will change:
429 Too Many Requests

JSON XML

Example

Request

GET /V1/Merchant/Videos?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Merchant/Videos?apiKey=ABC123 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

[
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "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/"
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Video 2",
        "VideoUrl": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
        "ButtonColour": "Red",
        "ButtonText": "Click Here",
        "HoverText": "Click here to buy now",
        "TargetUrl": "https://www.example.com/"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Video 3",
        "VideoUrl": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
        "ButtonColour": "Red",
        "ButtonText": "Click Here",
        "HoverText": "Click here to buy now",
        "TargetUrl": "https://www.example.com/"
    }
]
<VideoArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Video>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <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>
    </Video>
    <Video>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Video 2</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>
    </Video>
    <Video>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Video 3</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>
    </Video>
</VideoArray>

Related Links