Offerit REST API Get Creatives Fields - Revision history

Offeritnick at 21:24, 12 May 2017

2017-05-12T21:24:47Z

OfferitRob at 20:47, 22 March 2017

2017-03-22T20:47:13Z

OfferitRob at 20:27, 22 March 2017

2017-03-22T20:27:46Z

OfferitRob at 18:49, 22 March 2017

2017-03-22T18:49:09Z

OfferitRob: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /creative/get_creative_fields''' == '''Description''' *Use this API end point to get the list of fields for a..."

2017-03-22T18:48:39Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /creative/get_creative_fields''' == '''Description''' *Use this API end point to get the list of fields for a..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}

== '''GET /creative/get_creative_fields''' ==
'''Description'''
*Use this API end point to get the list of fields for a creative type.

'''Resource URL'''
*<nowiki>http://domain/api/creative/get_creative_fields</nowiki>
*Replace domain with your NATS for Networks 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'''
**'''''this is the id of the creative type

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

'''GET'''
<nowiki>http://domain/api/creative/get_creative_fields</nowiki>

*Response:
<pre>
array(2) {
'result' =>
string(7) "success"
'message' =>
array(1) {
'image_banners' =>
array(2) {
'types' =>
array(2) {
...
}
'fields' =>
array(7) {
...
}
}
}
}
</pre>
**''''' result will be error with the reason in message on failure

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

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/creative/get_creative_fields';

$data = Array(
'creative_type_id' => 1,
);
$data_string = http_build_query($data);
$url .= '?'.$data_string;

$curl = curl_init();

$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
var_dump(json_decode($resp, true));

// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 1: / Line 1: @@
 {{Offerit  Manual
-| show_REST_api_section = true
+| show_rest_api_section = true
 }}

@@ Line 80: / Line 80: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources

@@ Line 9: / Line 9: @@
 '''Resource URL'''
 *<nowiki>http://domain/api/creative/get_creative_fields</nowiki>
-*Replace domain with your NATS for Networks domain
+*Replace domain with your Offerit domain
 '''Response Format'''