Difference between revisions of "Offerit REST API Get Creatives Fields"
From Offerit
OfferitRob (talk | contribs) |
Offeritnick (talk | contribs) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Offerit Manual | {{Offerit Manual | ||
| − | | | + | | show_rest_api_section = true |
}} | }} | ||
| Line 80: | Line 80: | ||
$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 | ||
Latest revision as of 17:24, 12 May 2017
GET /creative/get_creative_fields
Description
- Use this API end point to get the list of fields for a creative type.
Resource URL
- http://domain/api/creative/get_creative_fields
- Replace domain with your 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_creative_fields
- Response:
array(2) {
'result' =>
string(7) "success"
'message' =>
array(1) {
'image_banners' =>
array(2) {
'types' =>
array(2) {
...
}
'fields' =>
array(7) {
...
}
}
}
}
- result will be error with the reason in message on failure
Example Code
PHP
<?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 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);
?>
