◆ Sapport для разработчиков Справочник API Каталог ошибок OpenAPI
Разделы

#Публикатор статей: обзор

Статус: публикация на сайт через модуль — Доступно; чтение статей по API (GET /articles, GET /articles/{id}) — Доступно; правка, утверждение, публикация и генерация по API — Планируется. Через кабинет Sapport статьи создаются, утверждаются и отправляются на ваш сайт модулем для Bitrix или WordPress уже сейчас. Публичный API правки и публикации (PATCH, approve, publish), генерация (/articles/generation-jobs) и выдача статьи вашей системе — проект. Пакеты FastAPI и Nuxt в публичный доступ не выпущены. Сроки не обещаются.

Публикатор статей — это конвейер от темы до страницы на вашем сайте. Платформа подбирает или принимает тему, пишет статью по профилю вашей редакции, ставит её в очередь на утверждение и, когда вы разрешили, публикует на ваш сайт. Если ваш сайт — не Bitrix и не WordPress, статью можно выдать вашей системе событием и API, а вы публикуете сами.

#Из чего состоит конвейер

ЭтапЧто происходитГде сейчас
Профиль редакцииВы описываете нишу, аудиторию, тон, источники темКабинет — Доступно
ГенерацияИИ пишет статью по теме и профилю; платная операцияКабинет — Доступно; API — Планируется
ОчередьСтатья появляется в очереди со статусом, правится, утверждаетсяКабинет — Доступно; чтение по API — Доступно, правка и утверждение — Планируется
ПубликацияСтатья уходит на сайт через модуль или выдаётся вамМодули — Доступно; выдача — Планируется

#Профиль редакции

Профиль — условие генерации: без него платформа не знает, о чём и для кого писать. Профиль включает:

ПолеОбязательноОписание
nicheдаНиша: о чём ваш сайт
audienceнетДля кого вы пишете
toneнетТон текста
presentationнетПодача материала
topic_sourcesнетОткуда брать темы: own_site, wordstat, search_console, competitors, manual, urls
source_urlsнетАдреса, на которые нужно опираться
avoidнетЧего избегать
example_textнетОбразец текста, на который равняться
localeнетЯзык статей

Если профиль не заполнен, запрос генерации получает отказ 409 editorial_profile_required (код из каталога ошибок).

#Что такое статья на платформе

У статьи есть статус жизненного цикла:

СтатусСмысл
draftЧерновик: только что сгенерирована или в правке
reviewНа проверке
approvedУтверждена, готова к публикации
publishedОпубликована
transferredПеренесена в другое место платформы
externalОпубликована вне платформы (внешняя статья)

Внутренние статусы показаны для понимания. Состав и имена статусов публичного API в проекте не утверждены (см. «Открытые вопросы»). Публичный статус «Опубликована» должен подтверждаться реальным адресом страницы, а не одной отметкой.

#Два способа получить статью на сайт

#Способ 1. На сайт через модуль

Подходит, если у вас Bitrix (модуль 1.2.1) или WordPress (модуль 1.1.1). Вы привязываете сайт модулем, а затем в кабинете нажимаете «Опубликовать на сайт через модуль». Платформа формирует задание, модуль забирает его при очередном опросе (раз в 10 минут; об ожидающих заданиях модулю сообщает и ежечасный heartbeat), применяет и возвращает итог: адрес страницы или причину отказа.

Подробности, формат задания и коды результатов — Публикация через модули.

#Способ 2. Выдача статьи вашей системе

Подходит, если CMS у вас своя. Платформа сообщает событием article.ready, вы забираете текст через API (GET /articles/{id}, форматы html, markdown, blocks), публикуете у себя и сообщаете адрес страницы. Пока адрес не подтверждён, статья считается выданной, а не опубликованной.

Эта схема — Планируется; её шаги описаны в API статей. В обоих способах статья, которую вы правите на своём сайте, не перезаписывается молча — см. «Версии и конфликты» в Публикации через модули.

#Кто что может

ДействиеМинимальное право (кабинет)Область (будущий API)
Смотреть очередь и статьиseo.viewarticles:read
Править, утверждать, публиковатьseo.managearticles:write
Заказать генерацию (платно)seo.managearticles:generate

#Что не входит в публичный API

Часть возможностей работает только на самой площадке Sapport и арендаторам недоступна: собственный блог платформы, страницы курсов площадки, «глубокий» режим генерации. Публичный API работает с вашими статьями и вашим сайтом.

#Деньги

Генерация списывается с кошелька арендатора. При нехватке средств платформа возвращает 402 insufficient_funds; предел трат задаётся на арендатора и на интеграцию. По умолчанию одновременно выполняется не более 5 платных операций на арендатора, а стоимость одной операции не превышает эквивалента 100 ₽ в валюте кошелька (оба предела настраиваются; при превышении — 402 spend_limit_reached). Стоимость каждой операции приходит в поле usage. Публикация и правка бесплатны. Подробности — Платные операции.

#Куда дальше

#Открытые вопросы