Offerit REST API Get Creatives - Revision history

Offeritnick at 21:24, 12 May 2017

2017-05-12T21:24:06Z

Offeritnick at 16:18, 12 May 2017

2017-05-12T16:18:48Z

Offeritnick: /* Parameters */

2017-05-12T15:57:31Z

‎Parameters

Offeritnick: /* Example Code */

2017-05-12T15:56:55Z

‎Example Code

OfferitRob: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /creative/get_creatives''' == '''Description''' *get_creatives Accepts the creative_type_id and returns the deta..."

2016-10-03T15:50:01Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /creative/get_creatives''' == '''Description''' *get_creatives Accepts the creative_type_id and returns the deta..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}
== '''GET /creative/get_creatives''' ==
'''Description'''
*get_creatives Accepts the creative_type_id and returns the details of the creatives assigned to that type.

'''Resource URL'''
*<nowiki>http://domain/api/creative/get_creatives</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

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

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

== '''Parameters''' ==
*creative_type_id
**'''''type: integer'''''
**'''''required'''

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

'''GET'''

<nowiki>http://domain/api/creative/get_creatives?creative_type_id=1</nowiki>

*Response:
<pre>
{"1": {
"type_details": {
"name": "Image Banners",
"description": "Image Banners",
"deleted": "0",
"creative_category_id": "1"
},
"creatives": {
"1": {"details": {
"deleted": "1",
"date_added": "1416245622",
"last_modified": "1416245622",
"pending": "0",
"name": "Hydrangeas.jpg",
"height": "768",
"width": "1024",
"size": "595284",
"thumb_ext": "jpg",
"alt": "",
"type": "1",
"hosted_url": "",
"creativeid": "1"
}},
"2": {"details": {
"deleted": "1",
"date_added": "1416245639",
"last_modified": "1416245639",
"pending": "0",
"name": "Lighthouse.jpg",
"height": "768",
"width": "1024",
"size": "561276",
"thumb_ext": "jpg",
"alt": "",
"type": "1",
"hosted_url": "",
"creativeid": "2"
}},
"133": {"details": {
"deleted": "0",
"date_added": "1473794648",
"last_modified": "1473794837",
"pending": "0",
"name": "not-giant-enough-letter-b.jpg",
"height": "550",
"width": "550",
"size": "9298",
"thumb_ext": "jpg",
"alt": "",
"type": "2",
"hosted_url": "http://i.c-b.co/is/image/LandOfNod/Letter_Giant_Enough_B_231606_LL/$web_zoom$%26wid%3D550%26hei%3D550%26/1308310656/not-giant-enough-letter-b.jpg",
"creativeid": "133"
}}
}
}}
</pre>

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

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

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
$data = Array(
'creative_type_id' => 1
);

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

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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 119: / Line 119: @@
 $output = json_decode($resp, true);
 if($output !== NULL) {
-    //json was valid. Dump the decoded array
+	//json was valid. Dump the decoded array
-    var_dump($output);
+	print_r($output);
+}
 else {
-    //invalid json, just dump the raw response
+	//invalid json, just dump the raw response
-    var_dump($resp);
+	print_r($resp);
+}

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section = true
 }}
 == '''GET /creative/get_creatives''' ==

@@ Line 23: / Line 23: @@
 **'''''type: integer'''''
 **'''''required'''
 == '''Example Request''' ==

@@ Line 100: / Line 100: @@
      'api-key: 44b5498dbcb481a0d00b404c0169af62',
      'api-username: productsupport'
 );
 $data = Array(
-	'creative_type_id' => 1
+    'creative_type_id' => 1
 );
-$data_string = http_build_query($data);
+$url .= '?' . http_build_query($data);
 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
 curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
 curl_setopt($curl, CURLOPT_URL, $url);
 // Close request to clear up some resources
 curl_close($curl);
 ?>
 </pre>
 [[Category:Offerit API Articles]]