Offerit REST API Set Affiliate Payvia Info - Revision history

Offeritnick at 21:23, 12 May 2017

2017-05-12T21:23:23Z

OfferitRob at 20:46, 22 March 2017

2017-03-22T20:46:35Z

OfferitDave at 19:06, 9 November 2016

2016-11-09T19:06:09Z

OfferitDave: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''PATCH /affiliate/setpayviainfo''' == '''Description''' *The /affiliate/setpayviainfo action is a feature in Offer..."

2016-01-13T16:00:44Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''PATCH /affiliate/setpayviainfo''' == '''Description''' *The /affiliate/setpayviainfo action is a feature in Offer..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}
== '''PATCH /affiliate/setpayviainfo''' ==
'''Description'''
*The /affiliate/setpayviainfo action is a feature in [[Offerit]] that allows you to set the affiliate payvia info settings

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*loginid: is the affiliates loginid
**'''''type: string'''''
**required

*payvia_type_id: is the id of the payvia that the loginid should be switched to
**'''''type: string'''''
**required

*payvia_info: is an array containing arrays of info to update for the payvia type.
**'''''type: array'''''
**required

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki>

*Response:
<pre>
[
{
"field":"Payvia Type",
"result":"Updated Payvia Type to 1 for loginid 1"
},
{
"field":"Pay To",
"result":"Updated Payvia Info: 'Pay To' is now 'TestPayTo'"
},
{
"field":"Address",
"result":"Updated Payvia Info: 'Address' is now 'Riga, Latvia'"
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$payvia_info = array();
$payvia_info[] = array(
'field' => 'Pay To',
'value' => 'TestPayTo'
);
$payvia_info[] = array(
'field' => 'Address',
'value' => 'Riga, Latvia'
);

$data = array(
'loginid' => 1,
'payvia_type_id' => '1',
'payvia_info' => $payvia_info
);

$url = 'http://domain/api/affiliate/setpayviainfo';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section = true
 }}
 == '''PATCH /affiliate/payvia''' ==

@@ Line 95: / Line 95: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

@@ Line 2: / Line 2: @@
 | show_api_admin_section = true
 }}
-== '''PATCH /affiliate/setpayviainfo''' ==
+== '''PATCH /affiliate/payvia''' ==
 '''Description'''
-*The  /affiliate/setpayviainfo action is a feature in [[Offerit]] that allows you to set the affiliate payvia info settings
+*The  /affiliate/payvia action is a feature in [[Offerit]] that allows you to set the affiliate payvia info settings
 '''Resource URL'''
-*<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki>
+*<nowiki>http://domain/api/affiliate/payvia</nowiki>
 *Replace domain with the offerit domain
@@ Line 39: / Line 39: @@
 '''PATCH'''
-<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki>
+<nowiki>http://domain/api/affiliate/payvia</nowiki>
 *Response:
@@ Line 82: / Line 82: @@
 );
-$url = 'http://domain/api/affiliate/setpayviainfo';
+$url = 'http://domain/api/affiliate/payvia';
 $headers = array(