Content API for Developers
Authorization
First of all, for authorization, it is necessary to pass the API key in the request header.
Request:
X-AUTH-TOKEN string Unique authorization token of the project
Getting Author Data
Parameters:
jaid string Author unique identifier
Return:
You will get all available authors' data
| Parameters | Type | Description |
|---|---|---|
| jaid | string |
Unique identifier |
| name | string |
Name |
| photo | string / null |
Photo URL |
| info | string / null |
Description |
| country | string / null |
Country |
| tags | array / null |
Interests |
| rating | integer |
Rating score |
| language | array / null |
Languages |
Request:
Response:
{
"jaid": "ab35c8ca-20bc-44ba-bf75-8ca0fc003e04",
"name": "Alex Walters",
"photo": "https://res.cloudinary.com/alex_walters.png",
"info": "<p>Orci varius natoque penatibus et magnis dis parturient montes.<p>...",
"country": "Spain",
"tags": {
"27": "Science",
"403": "Alice In Wonderland"
},
"rating": 1150,
"language": {
"003": "Português",
"002": "Español"
}
}
Getting Publication Data
Parameters:
chpu string Publication unique identifier
Return:
You will get all available information about content publication
| Parameter | Type | Description |
|---|---|---|
| jaid | string |
Author unique identifier |
| title | string |
Publication title |
| imagePreview | string / null |
Pubication preview image |
| authorName | string |
Author's name |
| authorPhoto | string / null |
Author's photo URL |
| body | string / null |
Publication content body |
| description | string / null |
Publication short description |
| views | integer |
Publication view counts |
| readingTime | float |
Publication reading time |
| metaTitle | string |
Meta title |
| metaDescription | string / null |
Meta description |
| keywords | string / null |
Keywords |
| ctaHeader | string / null |
CTA-block title |
| ctaButton | string / null |
CTA-block button |
| ctaDescription | string / null |
CTA-block description |
| ctaLink | string / null |
CTA-block button URL |
| chpu | string |
Publication unique identifier |
| publishedDate | DateTime |
Date and time of publishing |
| tagNames | array |
List of interests of the publication |
| projectDomain | string |
Site domain where the content was published |
| projectName | string |
Site name where the content was published |
| indexed | bool |
Indexation of the publiahed conten |
| language | string |
Published content language, deafault - ISO-639-1 |
| emailSubject | string |
Email subject for publication |
| emailPreheader | string |
Email preheader for publication |
| updateDate | DateTime |
Last update date of the publication |
Request
Response:
{
"id": 1384,
"title": "Winter Lucky Numbers",
"imagePreview": "https://res.cloudinary.com/articles/preview/550.jpg",
"authorName": "Alex Walters",
"authorPhoto": "https://res.cloudinary.com/alex_walters.png",
"body": "<p>${adv}</p>\r\n<h2>Aries</h2>\r\n<p>March 21 - April 19</p>...",
"description": "Having a lucky number can come in handy in certain situations like playing the lottery or betting.",
"views": 464,
"readingTime": 0.52,
"metaTitle": "Winter Lucky Numbers",
"metaDescription": " Do you know the luckiest numbers of your zodiac sign? However, there are some that are particularlylucky for a particular season. Which of them will bring you luck this winter? Check now!",
"keywords": "Zodiac, zodiac signs, astrology, horoscope",
"ctaHeader": "YOUR DESTINY Rune Readings",
"ctaButton": "Ask what will happen",
"ctaDescription": "Reveal your future, explore possible outcomes, and get answers to Yes/No questions 24/7.",
"ctaLink": "https://example.com/landing/rune-subscription",
"jaid": "b94e609c-2a78-488b-a9ff-71b631753010",
"chpu": "winter-lucky-numbers",
"publishedDate": {
"date": "2022-02-09 17:12:39.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"tagNames": {
"208": "Astrology",
"558": "Winter"
},
"projectDomain": "example.com",
"projectName": "Example",
"indexed": true,
"advBanners": {},
"emailSubject": "Check now to make the right choices!",
"emailPreheader": "What are your lucky numbers for this winter?",
"updateDate": {
"date": "2022-03-15 15:34:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
}
Getting All Publications for site/sites
Parameters:
| Parameter | Type | Description |
|---|---|---|
| limit | integer / null |
Number of requested publications |
| ordering | random publishedDate string / null |
Sorting type of requested publications: random selection, by publication date |
| tags | string / null |
List of id tags of interests (separated by comma) |
| offset | integer / null |
Offset for pagination |
| language | string / null |
Language of requested publications, default - ISO-639-1 |
| section | string / null |
Filter by section |
Return:
Publications Array
Request:
Response:
Similar to the response for Information About Publication
Sending Publication Views Data
Support cross-origin requests
Parameters:
id integer Publication unique identifier
Request:
Response:
Getting Interests Data
Return:
You will get the list of available content tags of interests
| Parameter | Type | Description |
|---|---|---|
| id | integer |
ID in the platform |
| name | string |
Tag name |
Request:
Response: