Difference between revisions of "Offerit REST API Get Creatives"
From Offerit
Offeritnick (talk | contribs) (→Parameters) |
Offeritnick (talk | contribs) |
||
Line 1: | Line 1: | ||
{{Offerit Manual | {{Offerit Manual | ||
− | | | + | | show_rest_api_section = true |
}} | }} | ||
== '''GET /creative/get_creatives''' == | == '''GET /creative/get_creatives''' == |
Revision as of 12:18, 12 May 2017
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
- http://domain/api/creative/get_creatives
- Replace domain with the Offerit domain
Response Format
- JSON
- GET
- HTTP headers
Parameters
- creative_type_id
- type: integer
- required
- this is the id of the creative type
Example Request
GET
http://domain/api/creative/get_creatives?creative_type_id=1
- Response:
{"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" }} } }}
Example Code
PHP
<?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 ); $url .= '?' . http_build_query($data); //set curl options curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_URL, $url); // do the api call $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 var_dump($output); } else { //invalid json, just dump the raw response var_dump($resp); } // Close request to clear up some resources curl_close($curl); ?>