{"id":981,"date":"2014-08-05T03:49:17","date_gmt":"2014-08-05T03:49:17","guid":{"rendered":"http:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/?p=981"},"modified":"2015-03-04T06:31:40","modified_gmt":"2015-03-04T06:31:40","slug":"api-retrieving-info-affiliates-profile","status":"publish","type":"post","link":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981","title":{"rendered":"API \u2013 Retrieving Info from an Affiliate’s Profile"},"content":{"rendered":"

This documentation is only for developers. If you are not a developer with good PHP coding skills then you have no need to read this.<\/span><\/strong><\/p>\n

It is very hard to troubleshoot another coder\u2019s code. So if you use this documentation and do a custom integration yourself then please note that we cannot offer you any support in terms of what is wrong with your code. You will need to hire us to take a look at your code and correct any mistakes you made.<\/strong><\/span><\/p>\n

\n

You can also retrieve referrer details using shortcode<\/a> offered by this plugin (this doesn’t require you to use the API).<\/p>\n<\/div>\n

This API allows you to retrieve a particular info from your affiliate’s profile\u00a0via a HTTP GET or POST request. If you want to use this API then you need to enable it from the settings menu. The following is a screenshot of this section in the “Integration Related<\/strong>” settings menu:<\/p>\n

\"\"

Additional Integration Options Screenshot<\/p><\/div>\n

Once you enable it, you can start to send request to a\u00a0URL to retrieve affiliate’s info programmatically.<\/p>\n

You need a minimum of 3 pieces of information to\u00a0do this\u00a0via a HTTP request. These are:<\/p>\n

    \n
  • Secret word (the secret word that you have specified in the settings)<\/li>\n
  • Referrer ID (the affiliate ID)<\/li>\n
  • Info\u00a0(the value of the field you want to retrieve)<\/li>\n<\/ul>\n

    Option 1. HTTP GET request<\/h2>\n

    To do this\u00a0via HTTP GET use the following format:<\/p>\n

    \r\nhttp:\/\/www.example.com\/wp-content\/plugins\/wp-affiliate-platform\/api\/get_user_data.php?secret=XX&ap_id=YY&info=ZZ\r\n<\/pre>\n
    Replace the “example.com”, “XX”, “YY”, “ZZ” with the appropriate value.<\/p>\n
    PHP Code Example<\/h4>\n
    The following is an example of how to construct this link using PHP. The following will retrieve the “email” field value of the affiliate with ID “tips21”<\/p>\n
    \r\n$secret = \"4bd39e2e4a7bb\";\r\n$referrer = \"tips21\";\r\n$info = \"email\";\r\n$prepared_data = \"?secret=\".$secret.\"&ap_id=\".$referrer.\"&info=\".$info;\r\n$get_url = \"http:\/\/www.example.com\/wp-content\/plugins\/wp-affiliate-platform\/api\/get_user_data.php\".$prepared_data;\r\n\/\/ Execute this GET Request\r\nfile_get_contents($get_url);\r\n<\/pre>\n
    Option 2. HTTP POST request<\/h2>\n
    To use\u00a0HTTP POST use the following format:<\/p>\n
    \r\n<form method=\"post\" action=\"http:\/\/www.example.com\/wp-content\/plugins\/wp-affiliate-platform\/api\/get_user_data.php\">\r\n<input type=\"hidden\" name=\"secret\" value=\"XX\">\r\n<input type=\"hidden\" name=\"ap_id\" value=\"YY\">\r\n<input type=\"hidden\" name=\"info\" value=\"ZZ\">\r\n<input type=submit value=\"Submit Post\">\r\n<\/form>\r\n<\/pre>\n
    Replace the “example.com”, “XX”, “YY”, “ZZ” with the appropriate value.<\/p>\n
    PHP Code Example<\/h4>\n
    The following PHP example code will retrieve the “email” address field value of the affiliate with ID “tips21”<\/p>\n
    $affiliate_id = \"tips21\"; \/\/ The affiliate ID of the user in question\r\n$info = \"email\"; \/\/What info to retrieve. In this case, the email address.\r\n\r\n\/\/ The Post URL (replace \"example.com\" with your actual domain-name)\r\n$postURL = \"http:\/\/www.example.com\/wp-content\/plugins\/wp-affiliate-platform\/api\/get_user_data.php\";\r\n\r\n\/\/ The Secret key (Get this value from the settings menu of this plugin)\r\n$secret_key = \"4bc67180656782.45045137\";\r\n\r\n\/\/ Prepare the data\r\n$data = array ();\r\n$data['secret'] = $secret_key;\r\n$data['ap_id'] = $affiliate_id;\r\n$data['info'] = $info;\r\n\r\n\/\/ send data to post URL to award the commission\r\n$ch = curl_init ($postURL);\r\ncurl_setopt ($ch, CURLOPT_POST, true);\r\ncurl_setopt ($ch, CURLOPT_POSTFIELDS, $data);\r\ncurl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);\r\n$returnValue = curl_exec ($ch);\r\ncurl_close($ch);<\/pre>\n
    If the affiliate ID you specified in the request is invalid (doesn’t exist), then it will show an error. Otherwise, it will show the value of the field.<\/p>\n","protected":false},"excerpt":{"rendered":"
    This documentation is only for developers. If you are not a developer with good PHP coding skills then you have no need to read this. It is very hard to troubleshoot another coder\u2019s code. So if you use this documentation and do a custom integration yourself then please note that we cannot offer you any […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_genesis_hide_title":false,"_genesis_hide_breadcrumbs":false,"_genesis_hide_singular_image":false,"_genesis_hide_footer_widgets":false,"_genesis_custom_body_class":"","_genesis_custom_post_class":"","_genesis_layout":"","footnotes":""},"categories":[3],"tags":[11,52,37],"class_list":{"0":"post-981","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-additional-resources","7":"tag-3rd-party-integration","8":"tag-affiliate","9":"tag-affiliate-platform-api","10":"entry"},"yoast_head":"\nAPI \u2013 Retrieving Info from an Affiliate's Profile<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"admin\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981\"},\"author\":{\"name\":\"admin\",\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#\/schema\/person\/b3a690506213824832751de546a340fb\"},\"headline\":\"API \u2013 Retrieving Info from an Affiliate’s Profile\",\"datePublished\":\"2014-08-05T03:49:17+00:00\",\"dateModified\":\"2015-03-04T06:31:40+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981\"},\"wordCount\":363,\"commentCount\":0,\"image\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage\"},\"thumbnailUrl\":\"http:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png\",\"keywords\":[\"3rd party Integration\",\"affiliate\",\"Affiliate Platform API\"],\"articleSection\":[\"Additional Resources\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981\",\"url\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981\",\"name\":\"API \u2013 Retrieving Info from an Affiliate's Profile\",\"isPartOf\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage\"},\"thumbnailUrl\":\"http:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png\",\"datePublished\":\"2014-08-05T03:49:17+00:00\",\"dateModified\":\"2015-03-04T06:31:40+00:00\",\"author\":{\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#\/schema\/person\/b3a690506213824832751de546a340fb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage\",\"url\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png\",\"contentUrl\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png\",\"width\":\"500\",\"height\":\"275\",\"caption\":\"Additional Integration Options Screenshot\"},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#website\",\"url\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/\",\"name\":\"WordPress Affiliate Platform\",\"description\":\"Take control of your affiliates and drive more sales\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#\/schema\/person\/b3a690506213824832751de546a340fb\",\"name\":\"admin\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/secure.gravatar.com\/avatar\/3a21ab4072e533cf470d80fc2f0fd3639872824ade4e23709397e109b24f8857?s=96&d=mm&r=g\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/3a21ab4072e533cf470d80fc2f0fd3639872824ade4e23709397e109b24f8857?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/3a21ab4072e533cf470d80fc2f0fd3639872824ade4e23709397e109b24f8857?s=96&d=mm&r=g\",\"caption\":\"admin\"},\"url\":\"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/author\/admin\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API \u2013 Retrieving Info from an Affiliate's Profile","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981","twitter_misc":{"Written by":"admin","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#article","isPartOf":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981"},"author":{"name":"admin","@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#\/schema\/person\/b3a690506213824832751de546a340fb"},"headline":"API \u2013 Retrieving Info from an Affiliate’s Profile","datePublished":"2014-08-05T03:49:17+00:00","dateModified":"2015-03-04T06:31:40+00:00","mainEntityOfPage":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981"},"wordCount":363,"commentCount":0,"image":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage"},"thumbnailUrl":"http:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png","keywords":["3rd party Integration","affiliate","Affiliate Platform API"],"articleSection":["Additional Resources"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981","url":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981","name":"API \u2013 Retrieving Info from an Affiliate's Profile","isPartOf":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage"},"image":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage"},"thumbnailUrl":"http:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png","datePublished":"2014-08-05T03:49:17+00:00","dateModified":"2015-03-04T06:31:40+00:00","author":{"@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#\/schema\/person\/b3a690506213824832751de546a340fb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/api-retrieving-info-affiliates-profile-981#primaryimage","url":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png","contentUrl":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-content\/uploads\/2010\/04\/wp-affiliate-api-remote-post-settings.png","width":"500","height":"275","caption":"Additional Integration Options Screenshot"},{"@type":"WebSite","@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#website","url":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/","name":"WordPress Affiliate Platform","description":"Take control of your affiliates and drive more sales","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/#\/schema\/person\/b3a690506213824832751de546a340fb","name":"admin","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/3a21ab4072e533cf470d80fc2f0fd3639872824ade4e23709397e109b24f8857?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/3a21ab4072e533cf470d80fc2f0fd3639872824ade4e23709397e109b24f8857?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/3a21ab4072e533cf470d80fc2f0fd3639872824ade4e23709397e109b24f8857?s=96&d=mm&r=g","caption":"admin"},"url":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/author\/admin"}]}},"_links":{"self":[{"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/posts\/981","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/comments?post=981"}],"version-history":[{"count":0,"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/posts\/981\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/media?parent=981"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/categories?post=981"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tipsandtricks-hq.com\/wordpress-affiliate\/wp-json\/wp\/v2\/tags?post=981"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}