The Support Services are a collection of REST 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.
|
Request |
Sample URI |
Sample Header |
|
languages |
https://support-services.api.cj.com/v2/languages? |
Click here for .txt file. |
|
categories |
https://support-services.api.cj.com/v2/categories? |
Click here for .txt file. |
|
countries |
https://support-services.api.cj.com/v2/countries? |
Click here for .txt file. |
|
link-types |
https://support-services.api.cj.com/v2/link-types? |
Click here for .txt file. |
|
link-sizes |
https://support-services.api.cj.com/v2/link-sizes? |
Click here for .txt file. |
Commission Junction's REST Web Services use the standard HTTP Authorization header to pass authentication information. You must provide your developer key to pass authentication. The request URI for the Publisher Lookup Service API must be properly encoded based on HTML 4 specification form content encoding rules. Please refer to http://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13.4 for the standard specification.
Note: Some languages may have built-in utility methods for encoding URIs based on RFC 1738. Unfortunately, these utility methods may not properly encode white space character and "+" character. Specifically, white space character should be encoded to "+" character, and "+" character should be encoded to "%2B".
Click the following links to display more specific information.
|
Header |
Description |
|
authorization |
Your developer key obtained from the Web Services Developer Site. |
All parameter names and values are case insensitive.
|
Parameter Name |
Description |
|
locale |
The 2-letter ISO-639-1 code for the desired language. Note: This parameter is only required for the categories and countries requests. |
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 categories 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 insensitive.
|
Request |
Description |
|
categories |
Returns an array of the advertiser sub-categories. You may view the current list of advertiser sub-categories by navigating to > 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. |
|
link-types |
Returns an array of the following link types.
|
|
link-sizes |
Returns an array of the following acceptable image dimensions for graphical links.
|
|
countries |
Returns an array of the two-letter ISO 3166-1 codes for countries supported by the Commission Junction system. The countries also apply to any serviceable-area request parameters. You may view the current list of supported countries by accessing the Additional Search Options drop down menu from the > of your CJ Account Manager. |
|
languages |
Returns an array of the two-letter ISO-639-1 codes for languages supported by the Commission Junction system. |
|
Error |
Description |
|
Not Authenticated |
The system could not authenticate your developer key. |