API Контента для Разработчиков
Аутентификация и авторизация
В первую очередь, для авторизации необходимо в заголовке запроса передать API ключ.
Запрос:
X-AUTH-TOKEN string уникальный авторизационный токен проекта
Получить информацию об авторе
Параметры:
jaid string Уникальный идентификатор автора
Данные ответа:
Вы получаете доступную полную информацию о запрашиваемом авторе контента
| Параметр | Тип | Описание |
|---|---|---|
| jaid | string |
Уникальный идентификатор автора |
| name | string |
Имя автора |
| photo | string / null |
Ссылка на фото автора |
| info | string / null |
Информация об авторе |
| country | string / null |
Страна автора |
| tags | array / null |
Интересы автора |
| rating | integer |
Рейтинг автора |
| language | array / null |
Языки, которыми владеет автор |
Запрос:
Ответ:
{
"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"
}
}
Получить информацию о публикации
Параметры:
chpu string Уникальный идентификатор публикации (ЧПУ)
Данные ответа:
Вы получаете доступную полную информцию о запрашиваемой публикации
| Параметр | Тип | Описание |
|---|---|---|
| jaid | string |
Уникальный идентификатор автора |
| title | string |
Название публикации |
| imagePreview | string / null |
Превью-изображение публикации |
| authorName | string |
Имя автора |
| authorPhoto | string / null |
Ссылка на фото автора |
| body | string / null |
Текст публикации |
| description | string / null |
Краткое описание публикации |
| views | integer |
Количество просмотров публикации |
| readingTime | float |
Время чтения публикации |
| metaTitle | string |
Meta-заголовок |
| metaDescription | string / null |
Meta-описание |
| keywords | string / null |
Список ключевых слов |
| ctaHeader | string / null |
Заголовок блока CTA |
| ctaButton | string / null |
Кнопка блока CTA |
| ctaDescription | string / null |
Описание блока CTA |
| ctaLink | string / null |
Ссылка блока CTA |
| chpu | string |
Уникальный идентификатор публикации (ЧПУ) |
| publishedDate | DateTime |
Дата и время публикации |
| tagNames | array |
Список тегов интересов публикации |
| projectDomain | string |
Домен проекта, на котором расположена публикации |
| projectName | string |
Имя проекта, на котором расположена публикации |
| indexed | bool |
Индексация статьи |
| language | string |
Язык публикации, стандарт - ISO-639-1 |
| advBanners | array |
Список рекламных блоков (для замены параметра ${adv} в тексте статьи) |
| emailSubject | string |
Тема письма для отправки |
| emailPreheader | string |
Прехедер письма для отправки |
| updateDate | DateTime |
Время обновления при изменении в публикации |
Запрос
Ответ:
{
"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"
},
}
Получить все публикации проекта / группы
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| limit | integer / null |
Количество запрашиваемых публикаций |
| ordering | random publishedDate string / null |
Тип сортировки запрашиваемых публикаций: рандомная выборка, по дате публикации |
| tags | string / null |
Список id тегов, разделенных запятой |
| offset | integer / null |
Смещение, для постраничной выборки |
| language | string / null |
Язык запрашиваемых публикаций, стандарт - ISO-639-1 |
| section | string / null |
Фильтр по разделу |
Возвращает:
Массив публикаций
Запрос:
Ответ:
Аналогично схеме ответа при запросе публикации
Отправить информацию о просмотре публикации
Поддерживает cross-origin запросы
Параметры:
id integer Уникальный идентификатор публикации
Запрос
*Ответ:
Получить все теги
Возвращает:
Список доступных тегов контента
Данные ответа:
| Параметр | Тип | Описание |
|---|---|---|
| id | integer |
ID тега в системе |
| name | string |
Имя тега |
Запрос:
Ответ: