Support Services

The Support Services are a collection of SOAP (Simple Object Access Protocol)-based APIs that enable developers to obtain updated lists of available options for certain request parameters. These services enable developers to pass the appropriate values for the certain parameters: Country, Language, Category, Link Type and Link Size.

The Support Services API contains the following five requests.

Refer to the following sections of this topic for more specific information.

Note: Refer to https://linksearch.api.cj.com for the most recent version of the Support Services WSDL. The WSDL provides all the programmatic information you need to use this API. The hand-edited version provides the information in a readable format; however, to ensure maximum compatibility with the system, use the AXIS version when developing your application.

Request Parameters

Refer to the following table for a list of the required request parameters. All parameter names and values are case sensitive.

Parameter Name

Value

Req?

Description

developerKey

String

Required

Your developer key obtained from the Web Services Developer Site.

locale

String

Required

The 2-letter ISO-639-1 code for the desired language.

Note: This parameter is only required for the getCategories and getCountries requests.

Response Fields

The response for any of the five requests is simply an array of strings, containing each possible value for the desired field. For example, the getCategories response is an array of the various category names currently available in the Commission Junction network. Refer to the table below for a description of each of the service responses. All parameter names and values are case sensitive.

Request

Description

getCategories

Returns an array of the advertiser sub-categories. You may view the current list of advertiser sub-categories by navigating to Get Links tab > General Categories sub-tab within your CJ Account Manager.

Important: The system does not support searching top-level categories. You must choose a specific sub-category in which to search. For example, if you want advertisers with medical equipment, you must use Equipment (the sub-category) as the value of the category parameter.

getLinkTypes

Returns an array of the following link types.

  • Banner

  • Advanced Link

  • Text Link

  • Content Link

  • SmartLink

  • Product Catalog

  • Advertiser SmartZone

  • Keyword Link

getLinkSizes

Returns an array of the following acceptable image dimensions for graphical links.

  • 88x31 Micro Bar

  • 120x60 Button 2

  • 120x240 Vertical Banner

  • 120x90 Button 1

  • 125x125 Square Button

  • 234x60 Half Banner

  • 468x60 Full Banner

  • 300x250 Medium Rectangle

  • 250x250 Square Pop-Up

  • 240x400 Vertical Rectangle

  • 336x280 Large Rectangle

  • 180x150 Rectangle

  • 160x600 Wide Skyscraper

  • 120x600 Skyscraper

  • 150x50 Banner

  • Other

getCountries

Returns an array of the countries supported by the Commission Junction system. The countries also apply to any serviceableArea request parameters.

You may view the current list of supported countries by accessing the Additional Search Options drop down menu from the Get Links tab > General Categories sub-tab of your CJ Account Manager.

getLanguages

Returns an array of the two-letter ISO-639-1 codes for languages supported by the Commission Junction system.

Errors

Error

Description

Not Authenticated

The system could not authenticate your developer key.