Creates new rental offer assigned to your publisher acccount. New offers inherit your currency and country.
Read more about all types of offers here.
Parameters
Name | Type | Description |
---|---|---|
publisherToken* | string | You can find your publisher token at api-keys page. |
offerData* | object | No description |
-price | float | Offer price (in publisher's currency) |
-title | string | Title of the offer. Up to 70 chars. |
-period | integer | Amount of time after which purchase will expire (in hours) |
-url | string | Url to content |
-description* | string | Additional offer description. Up to 110 chars. |
-videoId* | string | Link offer with unique video asset id |
-contentExternalId* | string | This parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you. |
-contentExternalData* | string | If you want to store a few extra elements related to the sale you can use this string to store additional data. |
-tags* | array | Tags attached to offer |
API Request/Response
Request
{
"method":"createRentalOffer",
"params":{
"publisherToken":"Y72a8Cr0KQciwzU7DbOcSXOFL1gT9a6gIYRb6hhOvCdPaxKW",
"offerData":{
"price":"19",
"title":"Monetize your content",
"period":"360",
"url":"http:\/\/your-site.url\/page_with_content",
"description":"Great article how you can monetize your content using Cleeng",
"videoId":"",
"contentExternalId":"",
"contentExternalData":"",
"tags":[
"sport",
"hockey"
]
}
},
"jsonrpc":"2.0",
"id":1
}
Response
{
"result":{
"id":"A233973213_US",
"publisherId":"761790883",
"url":"http:\/\/your-site.url",
"title":"Monetize your content",
"description":"Great article how you can monetize your content using Cleeng",
"currency":"EUR",
"videoId":"",
"contentExternalId":"",
"contentExternalData":"",
"averageRating":4,
"active":false,
"createdAt":1353067309,
"updatedAt":1353067309,
"price":12,
"tags":[
],
"period":"360"
},
"id":"1",
"error":null,
"jsonrpc":"2.0"
}
PHP Example
<?php
$offerSetup = array(
'title' => 'Bip Bip and Coyote - Episode 12',
'price' => 0.49,
'period' => 72,
'url' => 'http://your-site.com/watch/bipbip_12/',
'description' => 'Get 3-day access to watch how Bip Bip and Coyote are chasing each other for the 12th time. Watch it directly from your browser for a few pennies.',
'tags' => array('cartoon', 'bip bip and Coyote')
);
$cleengApi = new Cleeng_Api();
$cleengApi->setPublisherToken('VIJYHWzJEP4mt1DZThD7DV_FinBG0Yo3Q9oHfCFAjqA22jXP');
$cleengApi->createRentalOffer($offerSetup);
?>