Submit a Ticket My Tickets
Welcome
Login  Sign up

EXPORT Affiliates API Version 2 (DEPRECATED)

EXPORTS Affiliates API Version 2

Updated on 2014-03-26

Current Version: Version 2
Latest Version: Version 5
Deprecated Version: 
Requests Allowed: GET & SOAP 

 

Summary:

Returns an array of affiliates and its properties. This version includes linked contacts.

You can also obtain this from within your CAKE instance by going to affiliates tab >> affiliates >> export.

 

Resource/WSDL Page:

http://<your_domain_here>/api/2/export.asmx?op=Affiliates

 

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

This api_key will provide you with the ability to export Affiliates for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.

Example Value: 

Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

 affiliate_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Affiliate.  This can be found on any Affiliate card.

Example Values: 1234

 

 

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example Request

GET

http://demo.cakemarketing.com/api/2/export.asmx/Affiliates?api_key=dNJFmId9rI&affiliate_id=0

 

Sample XML Response:

<ArrayOfAffiliate>
  <Affiliate>
    <affiliate_id>6066</affiliate_id>
    <affiliate_name>#1 Affiliate</affiliate_name>
    <account_manager_id>3295</account_manager_id>
    <account_manager_name>Something Else</account_manager_name>
    <status_name>Active</status_name>
    <address/>
    <contacts>
      <Contact>
        <contact_id>3384</contact_id>
        <contact_type>Account Manager</contact_type>
        <email>test@cakemarketing.com</email>
        <include_in_mass_emails>false</include_in_mass_emails>
      </Contact>
    </contacts>
    <pay_for_conversions>true</pay_for_conversions>
    <review>false</review>
    <review_new_subaffiliates>false</review_new_subaffiliates>
    <throttle_active>false</throttle_active>
    <throttle_cap xsi:nil="true"/>
    <auto_approve_campaigns>false</auto_approve_campaigns>
    <auto_approve_pixels>false</auto_approve_pixels>
    <hide_offers>false</hide_offers>
    <payment_fee xsi:nil="true"/>
    <minimum_payment_threshold>10.0000</minimum_payment_threshold>
    <pay_vat>false</pay_vat>
    <tags>
      <string>Super</string>
      <string>Super Affiliate </string>
      <string>Testing Tag</string>
      <string>testing</string>
    </tags>
    <media_types>
      <MediaType>
        <type_id>7</type_id>
        <type_name>Banner</type_name>
        <category_id>1</category_id>
        <category_name>Display</category_name>
      </MediaType>
    </media_types>
    <price_formats>
      <string>CPA</string>
      <string>CPC</string>
    </price_formats>
    <vertical_categories>
      <string>BizOp</string>
    </vertical_categories>
    <countries>
      <Country>
        <country_abbr>US</country_abbr>
        <country_name>United States</country_name>
      </Country>
    </countries>
    <online_signup>false</online_signup>
    <referred_by>Childish Gambino</referred_by>
    <api_key>TyGBq5XwjE8</api_key>
    <date_created>2013-03-20T09:34:30.863</date_created>
    <notes>his traffic converts the best!</notes>
  </Affiliate>
</ArrayOfAffiliate>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.

Invalid Affiliate ID

Affiliate ID does not exist.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.