Difference between revisions of "Offerit REST API Check Orderid Exists"
From Offerit
OfferitRob (talk | contribs) |
Offeritnick (talk | contribs) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Offerit Manual | {{Offerit Manual | ||
| − | | | + | | show_rest_api_section = true |
}} | }} | ||
| − | == ''' | + | |
| + | == '''GET /offer/check_orderid_exists''' == | ||
'''Description''' | '''Description''' | ||
| − | * | + | *Offerit supports an API resource to check if an orderid exists. |
| + | |||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api// | + | *<nowiki>http://domain/api/offer/check_orderid_exsits</nowiki> |
*Replace domain with the Offerit domain | *Replace domain with the Offerit domain | ||
'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | '''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] | ||
| − | * | + | *GET |
'''Response Format''' | '''Response Format''' | ||
| Line 20: | Line 22: | ||
== '''Parameters''' == | == '''Parameters''' == | ||
| − | + | * '''orderid''' - The orderid to check. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 58: | Line 32: | ||
$data = array( | $data = array( | ||
| − | ' | + | 'orderid' => '12345678', |
| − | |||
); | ); | ||
| − | $url = 'http://domain/api/ | + | $data_string = http_build_query($data); |
| + | $url = 'http://domain/api/offer/check_orderid_exists?'.$data_string; | ||
$headers = array( | $headers = array( | ||
| Line 68: | Line 42: | ||
'api-username: productsupport' | 'api-username: productsupport' | ||
); | ); | ||
| − | |||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); | ||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); | ||
curl_setopt($curl, CURLOPT_URL, $url); | curl_setopt($curl, CURLOPT_URL, $url); | ||
| − | |||
| − | |||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
| − | //dumps an associative array representation of the json | + | //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 | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
?> | ?> | ||
| − | + | </pre> | |
| − | |||
| − | |||
[[Category:Offerit API Articles]] | [[Category:Offerit API Articles]] | ||
Latest revision as of 16:28, 12 May 2017
GET /offer/check_orderid_exists
Description
- Offerit supports an API resource to check if an orderid exists.
Resource URL
- http://domain/api/offer/check_orderid_exsits
- Replace domain with the Offerit domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
- orderid - The orderid to check.
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'orderid' => '12345678',
);
$data_string = http_build_query($data);
$url = 'http://domain/api/offer/check_orderid_exists?'.$data_string;
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
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);
?>
