NATS For Networks REST API Get Creatives

From TMMwiki
Jump to: navigation, search
NATS For Networks
REST API
General
API Overview
GET /service/ping
Advertiser
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
PATCH /affiliate/edit_affiliate
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
Creative
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
Offer
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
Reporting
GET /report/profitloss
GET /report/transaction
Transaction
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash

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 NATS for Networks domain

Response Format

  • JSON

Request Method

  • GET

Authentication

  • HTTP headers

Parameters

  • creative_type_id
    • type: integer
    • required

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
);                                                   

$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 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); 
?>