Skip to content
This repository has been archived by the owner on Sep 20, 2018. It is now read-only.

Signup Documentation

Nick edited this page Mar 8, 2017 · 6 revisions

Cake Marketing's API requires all fields associated with each method to be sent rather you are using them or not. This library sets some default values to these fields when appropriate. You can override the default values by passing in your own values for the fields. Fields set to "null" must be set by you when calling its associated method.

Complete documentation for each field can found on the GetCake support forum. Links are provided for each function.

GetMediaTypes

Returns an array of media types GetCake Documentation

Fields

N/A

Example Usage

use PhpFanatic\Cakemarketing\Signup;

$signup= new Signup([yourapikey], [yourapiurl]);
$xml = $signup->ApiCall('GetMediaTypes');

GetPriceFormats

Returns an array of price formats. GetCake Documentation

Fields

N/A

Example Usage

use PhpFanatic\Cakemarketing\Signup;

$signup = new Signup([yourapikey], [yourapiurl]);
$xml = $signup->ApiCall('GetPriceFormats');

GetTrafficTypes

Returns an array of traffic types. GetCake Documentation

Fields

N/A

Example Usage

use PhpFanatic\Cakemarketing\Signup;

$signup = new Signup([yourapikey], [yourapiurl]);
$xml = $signup->ApiCall('GetTrafficTypes');

GetVerticalCategories

Returns an array of verticals. GetCake Documentation

Fields

N/A

Example Usage

use PhpFanatic\Cakemarketing\Signup;

$signup= new Signup([yourapikey], [yourapiurl]);
$xml = $signup->ApiCall('GetVerticalCategories');

Advertiser

Returns an array of traffic types. GetCake Documentation

Fields

  • company_name : null
  • address_street : ''
  • address_street2 : ''
  • address_city : ''
  • address_state : ''
  • address_zip_code : ''
  • first_name : null
  • last_name : null
  • email_address : null
  • password : null
  • website : ''
  • notes : ''
  • contact_title : ''
  • contact_phone_work : ''
  • contact_phone_cell : ''
  • contact_phone_fax : ''
  • contact_im_name : ''
  • contact_im_service : -1
  • ip_address : null

Example Usage

use PhpFanatic\Cakemarketing\Signup;

$signup = new Signup([yourapikey], [yourapiurl]);
$data = ['company_name'=>'ABC Company', 'first_name'=>'John', 'last_name'=>'Smith', 'email_address'=>'jsmith@email.com']; //etc
$xml = $signup->ApiCall('Advertiser', $data);

Affiliate

Returns Message: "Affiliate Added Successfully" GetCake Documentation

Fields

  • affiliate_name : null

  • account_status_id : 3

  • affiliate_tier_id : 0

  • hide_offers : true

  • website : ''

  • tax_class : 'Other'

  • ssn_tax_id : ''

  • vat_tax_required : false

  • swift_iban : ''

  • payment_to : null

  • payment_min_threshold : 0

  • currency_id : 0

  • payment_setting_id : 0

  • billing_cycle_id : 0

  • payment_type_id : 0

  • payment_type_info : ''

  • address_street : ''

  • address_street2 : ''

  • address_city : ''

  • address_state : ''

  • address_zip_code : ''

  • address_country : ''

  • contact_first_name : ''

  • contact_middle_name : ''

  • contact_last_name : ''

  • contact_email_address : ''

  • contact_password : ''

  • contact_title : ''

  • contact_phone_work : ''

  • contact_phone_cell : ''

  • contact_phone_fax : ''

  • contact_im_name : ''

  • contact_im_service : -1

  • contact_timezone : ''

  • contact_language_id : 0

  • media_type_ids : null

  • price_format_ids : null

  • vertical_category_ids : null

  • country_codes : null

  • tag_ids : ''

  • date_added : date(m/d/Y H : m : s)

  • signup_ip_address :null

  • referral_affiliate_id : 0

  • referral_notes : ''

  • ip_address : null

Example Usage

use PhpFanatic\Cakemarketing\Signup;

$signup = new Signup([yourapikey], [yourapiurl]);
$data = ['company_name'=>'ABC Company', 'first_name'=>'John', 'last_name'=>'Smith', 'email_address'=>'jsmith@email.com']; //etc
$xml = $signup->ApiCall('Affiliate', $data);