Offerit REST API Set Currency Exchange Rates - Revision history

Offeritnick at 17:30, 16 July 2019

2019-07-16T17:30:00Z

Offeritnick at 18:17, 19 October 2018

2018-10-19T18:17:41Z

Offeritnick at 18:17, 19 October 2018

2018-10-19T18:17:27Z

Offeritnick: /* PATCH /affiliate/set_currency_exchange_rates */

2018-10-19T18:16:47Z

‎PATCH /affiliate/set_currency_exchange_rates

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} * COMING SOON * == '''PATCH /affiliate/set_currency_exchange_rates''' == '''Description''' * Decodes a..."

2018-10-19T18:13:41Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} <font="red">* COMING SOON *</font> == '''PATCH /affiliate/set_currency_exchange_rates''' == '''Description''' * Decodes a..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
<font="red">* COMING SOON *</font>
== '''PATCH /affiliate/set_currency_exchange_rates''' ==

'''Description'''
* Decodes a given ocode (tracking code) and returns an array of the ids and details that the ocode contains.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/set_currency_exchange_rates</nowiki>

'''Response Format'''
*JSON

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

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

== '''Parameters''' ==
*base
**'''''type: string'''''
**'''''required'''
** base currency to set rates for
*rates
**'''''type: array'''''
**'''''required'''
** Array of other currencies with the conversion rate to the "base" parameter above.

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

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/set_currency_exchange_rates';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'base' => 'USD',
'rates' => Array(
'EUR' => 0.8639308856,
'AUD' => 1.4094168468,
'CAD' => 1.3047084234,
),
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

== '''Example Output''' ==
<pre>
Array
(
[result] => success
[message] => Saved new rates to config. EUR: 0.8639308856; AUD: 1.4094168468; CAD: 1.3047084234;
)
</pre>

@@ Line 3: / Line 3: @@
 }}
 <font color="red">* COMING SOON *</font>
-== '''PATCH /affiliate/set_currency_exchange_rates''' ==
+== '''PATCH /service/set_currency_exchange_rates''' ==
 '''Description'''
@@ Line 9: / Line 9: @@
 '''Resource URL'''
-*<nowiki>http://domain/api/affiliate/set_currency_exchange_rates</nowiki>
+*<nowiki>http://domain/api/service/set_currency_exchange_rates</nowiki>
@@ Line 37: / Line 37: @@
 <pre>
 <?php
-$url = 'http://domain/api/affiliate/set_currency_exchange_rates';
+$url = 'http://domain/api/service/set_currency_exchange_rates';
 $curl = curl_init();

@@ Line 2: / Line 2: @@
 | show_rest_api_section = true
 }}
-<html><font color="red">* COMING SOON *</font></html>
+<font color="red">* COMING SOON *</font>
 == '''PATCH /affiliate/set_currency_exchange_rates''' ==

@@ Line 6: / Line 6: @@
 '''Description'''
-* Decodes a given ocode (tracking code) and returns an array of the ids and details that the ocode contains.
+* Sets currency exchange rates in your configuration. For example, in the Configuration Admin, "Currency - All" section, you can update the value for a rate such as "EUR Exchange Rate to USD".
 '''Resource URL'''