OpenAPI

Спецификация генерируется из PHP attributes (swagger-php) в репозитории dle_api: apidata/openapi.yaml.

cd upload/api && composer openapi

Сырой файл: openapi.yaml

Интерактивный playground рендерится ниже через Fumadocs OpenAPI (app/lib/openapi.ts).

Операции

/oauth/token

Выдача AuthToken (credential_type или grant_type)

Request Body

application/json

Параметры credential_type или OAuth2 grant

credential_type?string

Предпочтительный способ выдачи AuthToken

Value in

"api_key"
"auth"
"oauth_client"

grant_type?string

Value in

"client_credentials"
"authorization_code"
"refresh_token"
"password"

api_key?string

credential_type=api_key

client_id?string

client_secret?string

scope?string

code?string

redirect_uri?string

code_verifier?string

refresh_token?string

username?string

Логин или email (auth / password)

password?string

`application/json`

curl -X POST "https://example.com/oauth/token" \  -H "Content-Type: application/json" \  -d '{    "credential_type": "api_key",    "api_key": "your_api_key"  }'

{  "access_token": "…",  "token_type": "Bearer",  "expires_in": 3600,  "refresh_token": "…"}

/.well-known/oauth-authorization-server

OAuth AS discovery (без Bearer)

`application/json`

curl -X GET "https://example.com/.well-known/oauth-authorization-server"

{  "issuer": "string",  "authorization_endpoint": "string",  "token_endpoint": "string",  "revocation_endpoint": "string",  "userinfo_endpoint": "string",  "response_types_supported": [    "string"  ],  "grant_types_supported": [    "string"  ],  "code_challenge_methods_supported": [    "string"  ],  "token_endpoint_auth_methods_supported": [    "string"  ],  "credential_types_supported": [    "string"  ]}

/me

Субъект AuthToken (identity без CRUD-масок ПДн)

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

`application/json`

curl -X GET "https://example.com/me"

{  "sub": "string",  "user_id": 0,  "name": "string",  "email": "string",  "user_group": 0,  "user": {},  "api_key_id": 0,  "access_level": {},  "client_id": "string",  "auth_via": "access_token"}

/key/check

Проверка сырого API-ключа

Принимает Authorization: Bearer , возвращает ключ, scopes и payload me. validTo = null означает бессрочный ключ.

Authorization

rawApiKeyBearer

AuthorizationBearer <token>

Сырой API-ключ только для GET /key/check. Формат: Authorization: Bearer .

In: header

`application/json`

curl -X GET "https://example.com/key/check"

{  "apiKey": {    "key": "string",    "validFrom": "2019-08-24T14:15:22Z",    "validTo": "2019-08-24T14:15:22Z",    "accessLevel": {}  },  "scopes": {    "property1": {      "read": true,      "write": true,      "edit": true,      "delete": true    },    "property2": {      "read": true,      "write": true,      "edit": true,      "delete": true    }  },  "me": {}}

/oauth/userinfo

OIDC-совместимый userinfo (тот же payload, что /me)

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

`application/json`

curl -X GET "https://example.com/oauth/userinfo"

{  "sub": "string",  "user_id": 0,  "name": "string",  "email": "string",  "user_group": 0,  "user": {},  "api_key_id": 0,  "access_level": {},  "client_id": "string",  "auth_via": "string"}

/oauth/revoke

Отзыв токена

Request Body

application/json

token*string

Access или refresh token

`application/json`

curl -X POST "https://example.com/oauth/revoke" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'

{  "revoked": true}

/post/

Список новостей (фильтры как у /table/post/ + legacy headers)

Query-параметры колонок схемы; xf[name]=value для доп. полей; ! и % префиксы значений. Legacy: HTTP-заголовки с именами колонок (BC). category — virtual FK csv + post_extras_cats.

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Query Parameters

limit?integer

Default20

offset?integer

Default0

orderby?string

Колонка сортировки

sort?string

Default"DESC"

Value in

"ASC"
"DESC"

category?string

Virtual FK csv → category.id (FIND_IN_SET + post_extras_cats). !negate, %LIKE

approve?string

xf?

Доп. поля: xf[field]=value (pad-LIKE по xfields). Пример: xf[title]=foo

`application/json`

curl -X GET "https://example.com/post/"

{  "data": [    {      "id": 0,      "autor": "string",      "date": "string",      "short_story": "string",      "full_story": "string",      "xfields": "string",      "title": "string",      "descr": "string",      "keywords": "string",      "category": "string",      "alt_name": "string",      "comm_num": 0,      "allow_comm": 0,      "allow_main": 0,      "approve": 0,      "fixed": 0,      "allow_br": 0,      "symbol": "string",      "tags": "string",      "metatitle": "string"    }  ],  "count": 0}

Создание новости (sugar → prepare post)

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Request Body

application/json

Новость + optional nested children

Схема таблицы post.

id?integer

Первичный ключ (post.id)

autor?string

Автор (имя пользователя) (post.autor)

date?string

Дата/время (post.date)

short_story?string

Краткое описание (post.short_story)

full_story?string

Полный текст (post.full_story)

xfields?string

Доп. поля (xfields) (post.xfields)

title?string

Заголовок (post.title)

descr?string

Описание (post.descr)

keywords?string

Ключевые слова (post.keywords)

category?string

CSV id категорий (virtual FK csv → category.id)

alt_name?string

ЧПУ-имя (post.alt_name)

comm_num?integer

Колонка post.comm_num

allow_comm?integer

Колонка post.allow_comm

allow_main?integer

Колонка post.allow_main

approve?integer

Одобрено (0/1) (post.approve)

fixed?integer

Колонка post.fixed

allow_br?integer

Колонка post.allow_br

symbol?string

Колонка post.symbol

tags?string

Колонка post.tags

metatitle?string

Колонка post.metatitle

`application/json`

curl -X POST "https://example.com/post/" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 1}

/post/{id}

Новость по id

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

`application/json`

curl -X GET "https://example.com/post/0"

{  "data": {    "id": 0,    "autor": "string",    "date": "string",    "short_story": "string",    "full_story": "string",    "xfields": "string",    "title": "string",    "descr": "string",    "keywords": "string",    "category": "string",    "alt_name": "string",    "comm_num": 0,    "allow_comm": 0,    "allow_main": 0,    "approve": 0,    "fixed": 0,    "allow_br": 0,    "symbol": "string",    "tags": "string",    "metatitle": "string"  }}

/table/{name}

Список записей таблицы с фильтрами

Любая таблица SchemaRegistry. Фильтры = query-параметры колонок. Virtual FK (RelationMap): csv→FIND_IN_SET, one→=. Операторы: !negate, %LIKE. Пример: /table/banners/?category=1&approve=1. xf[name] если есть колонка xfields.

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

name*string

Логическое имя таблицы SchemaRegistry (banners, post, category, …)

Query Parameters

limit?integer

Default20

offset?integer

Default0

orderby?string

Колонка сортировки (из схемы)

sort?string

Default"DESC"

Value in

"ASC"
"DESC"

xf?

Доп. поля (если у таблицы есть xfields): xf[field]=value. Пример: xf[title]=foo

Response Body

`application/json`

curl -X GET "https://example.com/table/string"

{  "data": [    {      "id": 0,      "name": "string",      "date": 0,      "ip": "string",      "action": 0,      "extras": "string"    }  ],  "count": 0,  "table": "string"}

Создание записи (Fluent prepare)

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

name*string

Логическое имя таблицы SchemaRegistry

Request Body

application/json

Колонки выбранной таблицы (+ optional nested children). Схема = oneOf TableRow.

Тело записи: выберите схему по логическому имени таблицы в path {name} (SchemaRegistry).

Схема таблицы admin_logs.

id?integer

Первичный ключ (admin_logs.id)

name?string

Имя (admin_logs.name)

date?integer

Дата/время (admin_logs.date)

ip?string

IP-адрес (admin_logs.ip)

action?integer

Колонка admin_logs.action

extras?string

Колонка admin_logs.extras

Response Body

`application/json`

curl -X POST "https://example.com/table/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 1,  "table": "banners"}

/table/{name}/{id}

Запись по скалярному PK

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

name*string

Логическое имя таблицы SchemaRegistry

id*string

Значение первичного ключа

Response Body

`application/json`

curl -X GET "https://example.com/table/string/string"

{  "data": {    "id": 0,    "name": "string",    "date": 0,    "ip": "string",    "action": 0,    "extras": "string"  },  "table": "string"}

Обновление записи по скалярному PK

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

name*string

Логическое имя таблицы SchemaRegistry

id*string

Request Body

application/json

Тело записи: выберите схему по логическому имени таблицы в path {name} (SchemaRegistry).

Схема таблицы admin_logs.

id?integer

Первичный ключ (admin_logs.id)

name?string

Имя (admin_logs.name)

date?integer

Дата/время (admin_logs.date)

ip?string

IP-адрес (admin_logs.ip)

action?integer

Колонка admin_logs.action

extras?string

Колонка admin_logs.extras

Response Body

`application/json`

curl -X PUT "https://example.com/table/string/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "1",  "table": "banners",  "updated": true}

Удаление записи по скалярному PK

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

name*string

Логическое имя таблицы SchemaRegistry

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/table/string/string"

{  "id": "1",  "table": "banners",  "deleted": true}

/user/

Создание пользователя

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Request Body

application/json

Схема таблицы users.

email?string

E-mail (users.email)

password?string

Хеш пароля (users.password)

name?string

Имя (users.name)

user_id?integer

ID пользователя (users.user_id)

news_num?integer

Колонка users.news_num

comm_num?integer

Колонка users.comm_num

user_group?integer

ID группы (users.user_group)

lastdate?string

Колонка users.lastdate

reg_date?string

Колонка users.reg_date

banned?string

Колонка users.banned

allow_mail?integer

Колонка users.allow_mail

info?string

Колонка users.info

signature?string

Колонка users.signature

foto?string

Колонка users.foto

fullname?string

Колонка users.fullname

land?string

Колонка users.land

favorites?string

Колонка users.favorites

pm_all?integer

Колонка users.pm_all

pm_unread?integer

Колонка users.pm_unread

time_limit?string

Колонка users.time_limit

xfields?string

Доп. поля (xfields) (users.xfields)

allowed_ip?string

Колонка users.allowed_ip

hash?string

Колонка users.hash

logged_ip?string

Колонка users.logged_ip

restricted?integer

Колонка users.restricted

restricted_days?integer

Колонка users.restricted_days

restricted_date?string

Колонка users.restricted_date

timezone?string

Колонка users.timezone

news_subscribe?integer

Колонка users.news_subscribe

comments_reply_subscribe?integer

Колонка users.comments_reply_subscribe

twofactor_auth?integer

Колонка users.twofactor_auth

cat_add?string

Колонка users.cat_add

cat_allow_addnews?string

Колонка users.cat_allow_addnews

twofactor_secret?string

Колонка users.twofactor_secret

Response Body

`application/json`

curl -X POST "https://example.com/user/" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 1}

/usergroup/

Создание группы пользователей

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Request Body

application/json

Схема таблицы usergroups.

id?integer

Первичный ключ (usergroups.id)

group_name?string

Колонка usergroups.group_name

allow_cats?string

Колонка usergroups.allow_cats

allow_adds?integer

Колонка usergroups.allow_adds

cat_add?string

Колонка usergroups.cat_add

allow_admin?integer

Колонка usergroups.allow_admin

allow_addc?integer

Колонка usergroups.allow_addc

allow_editc?integer

Колонка usergroups.allow_editc

allow_delc?integer

Колонка usergroups.allow_delc

edit_allc?integer

Колонка usergroups.edit_allc

del_allc?integer

Колонка usergroups.del_allc

moderation?integer

Колонка usergroups.moderation

allow_all_edit?integer

Колонка usergroups.allow_all_edit

allow_edit?integer

Колонка usergroups.allow_edit

allow_pm?integer

Колонка usergroups.allow_pm

max_pm?integer

Колонка usergroups.max_pm

max_foto?string

Колонка usergroups.max_foto

allow_files?integer

Колонка usergroups.allow_files

allow_hide?integer

Колонка usergroups.allow_hide

allow_short?integer

Колонка usergroups.allow_short

time_limit?integer

Колонка usergroups.time_limit

rid?integer

Колонка usergroups.rid

allow_fixed?integer

Колонка usergroups.allow_fixed

allow_feed?integer

Колонка usergroups.allow_feed

allow_search?integer

Колонка usergroups.allow_search

allow_poll?integer

Колонка usergroups.allow_poll

allow_main?integer

Колонка usergroups.allow_main

captcha?integer

Колонка usergroups.captcha

icon?string

Колонка usergroups.icon

allow_modc?integer

Колонка usergroups.allow_modc

allow_rating?integer

Колонка usergroups.allow_rating

allow_offline?integer

Колонка usergroups.allow_offline

allow_image_upload?integer

Колонка usergroups.allow_image_upload

allow_file_upload?integer

Колонка usergroups.allow_file_upload

allow_signature?integer

Колонка usergroups.allow_signature

allow_url?integer

Колонка usergroups.allow_url

news_sec_code?integer

Колонка usergroups.news_sec_code

allow_image?integer

Колонка usergroups.allow_image

max_signature?integer

Колонка usergroups.max_signature

max_info?integer

Колонка usergroups.max_info

admin_addnews?integer

Колонка usergroups.admin_addnews

admin_editnews?integer

Колонка usergroups.admin_editnews

admin_comments?integer

Колонка usergroups.admin_comments

admin_categories?integer

Колонка usergroups.admin_categories

admin_editusers?integer

Колонка usergroups.admin_editusers

admin_wordfilter?integer

Колонка usergroups.admin_wordfilter

admin_xfields?integer

Колонка usergroups.admin_xfields

admin_userfields?integer

Колонка usergroups.admin_userfields

admin_static?integer

Колонка usergroups.admin_static

admin_editvote?integer

Колонка usergroups.admin_editvote

admin_newsletter?integer

Колонка usergroups.admin_newsletter

admin_blockip?integer

Колонка usergroups.admin_blockip

admin_banners?integer

Колонка usergroups.admin_banners

admin_rss?integer

Колонка usergroups.admin_rss

admin_iptools?integer

Колонка usergroups.admin_iptools

admin_rssinform?integer

Колонка usergroups.admin_rssinform

admin_googlemap?integer

Колонка usergroups.admin_googlemap

allow_html?integer

Колонка usergroups.allow_html

group_prefix?string

Колонка usergroups.group_prefix

group_suffix?string

Колонка usergroups.group_suffix

allow_subscribe?integer

Колонка usergroups.allow_subscribe

allow_image_size?integer

Колонка usergroups.allow_image_size

cat_allow_addnews?string

Колонка usergroups.cat_allow_addnews

flood_news?integer

Колонка usergroups.flood_news

max_day_news?integer

Колонка usergroups.max_day_news

force_leech?integer

Колонка usergroups.force_leech

edit_limit?integer

Колонка usergroups.edit_limit

captcha_pm?integer

Колонка usergroups.captcha_pm

max_pm_day?integer

Колонка usergroups.max_pm_day

max_mail_day?integer

Колонка usergroups.max_mail_day

admin_tagscloud?integer

Колонка usergroups.admin_tagscloud

allow_vote?integer

Колонка usergroups.allow_vote

admin_complaint?integer

Колонка usergroups.admin_complaint

news_question?integer

Колонка usergroups.news_question

comments_question?integer

Колонка usergroups.comments_question

max_comment_day?integer

Колонка usergroups.max_comment_day

max_images?integer

Колонка usergroups.max_images

max_files?integer

Колонка usergroups.max_files

disable_news_captcha?integer

Колонка usergroups.disable_news_captcha

disable_comments_captcha?integer

Колонка usergroups.disable_comments_captcha

pm_question?integer

Колонка usergroups.pm_question

captcha_feedback?integer

Колонка usergroups.captcha_feedback

feedback_question?integer

Колонка usergroups.feedback_question

files_type?string

Колонка usergroups.files_type

max_file_size?integer

Колонка usergroups.max_file_size

files_max_speed?integer

Колонка usergroups.files_max_speed

spamfilter?integer

Колонка usergroups.spamfilter

allow_comments_rating?integer

Колонка usergroups.allow_comments_rating

max_edit_days?integer

Колонка usergroups.max_edit_days

spampmfilter?integer

Колонка usergroups.spampmfilter

force_reg?integer

Колонка usergroups.force_reg

force_reg_days?integer

Колонка usergroups.force_reg_days

force_reg_group?integer

Колонка usergroups.force_reg_group

force_news?integer

Колонка usergroups.force_news

force_news_count?integer

Колонка usergroups.force_news_count

force_news_group?integer

Колонка usergroups.force_news_group

force_comments?integer

Колонка usergroups.force_comments

force_comments_count?integer

Колонка usergroups.force_comments_count

force_comments_group?integer

Колонка usergroups.force_comments_group

force_rating?integer

Колонка usergroups.force_rating

force_rating_count?integer

Колонка usergroups.force_rating_count

force_rating_group?integer

Колонка usergroups.force_rating_group

not_allow_cats?string

Колонка usergroups.not_allow_cats

allow_up_image?integer

Колонка usergroups.allow_up_image

allow_up_watermark?integer

Колонка usergroups.allow_up_watermark

allow_up_thumb?integer

Колонка usergroups.allow_up_thumb

up_count_image?integer

Колонка usergroups.up_count_image

up_image_side?string

Колонка usergroups.up_image_side

up_image_size?integer

Колонка usergroups.up_image_size

up_thumb_size?string

Колонка usergroups.up_thumb_size

allow_mail_files?integer

Колонка usergroups.allow_mail_files

max_mail_files?integer

Колонка usergroups.max_mail_files

max_mail_allfiles?integer

Колонка usergroups.max_mail_allfiles

mail_files_type?string

Колонка usergroups.mail_files_type

video_comments?integer

Колонка usergroups.video_comments

media_comments?integer

Колонка usergroups.media_comments

min_image_side?string

Колонка usergroups.min_image_side

allow_public_file_upload?integer

Колонка usergroups.allow_public_file_upload

force_comments_rating?integer

Колонка usergroups.force_comments_rating

force_comments_rating_count?integer

Колонка usergroups.force_comments_rating_count

force_comments_rating_group?integer

Колонка usergroups.force_comments_rating_group

max_downloads?integer

Колонка usergroups.max_downloads

admin_links?integer

Колонка usergroups.admin_links

admin_meta?integer

Колонка usergroups.admin_meta

admin_redirects?integer

Колонка usergroups.admin_redirects

allow_change_storage?integer

Колонка usergroups.allow_change_storage

self_delete?integer

Колонка usergroups.self_delete

allow_complaint_news?integer

Колонка usergroups.allow_complaint_news

allow_complaint_comments?integer

Колонка usergroups.allow_complaint_comments

allow_complaint_orfo?integer

Колонка usergroups.allow_complaint_orfo

flood_time?integer

Колонка usergroups.flood_time

max_c_negative?integer

Колонка usergroups.max_c_negative

max_n_negative?integer

Колонка usergroups.max_n_negative

rating_n_day?integer

Колонка usergroups.rating_n_day

rating_c_day?integer

Колонка usergroups.rating_c_day

allow_rating_change?integer

Колонка usergroups.allow_rating_change

allow_crating_change?integer

Колонка usergroups.allow_crating_change

Response Body

`application/json`

curl -X POST "https://example.com/usergroup/" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 1}

/plugin/

Регистрация плагина

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Request Body

application/json

Схема таблицы plugins.

id?integer

Первичный ключ (plugins.id)

name?string

Имя (plugins.name)

description?string

Колонка plugins.description

icon?string

Колонка plugins.icon

version?string

Колонка plugins.version

dleversion?string

Колонка plugins.dleversion

versioncompare?string

Колонка plugins.versioncompare

active?integer

Колонка plugins.active

mysqlinstall?string

Колонка plugins.mysqlinstall

mysqlupgrade?string

Колонка plugins.mysqlupgrade

mysqlenable?string

Колонка plugins.mysqlenable

mysqldisable?string

Колонка plugins.mysqldisable

mysqldelete?string

Колонка plugins.mysqldelete

filedelete?integer

Колонка plugins.filedelete

filelist?string

Колонка plugins.filelist

upgradeurl?string

Колонка plugins.upgradeurl

needplugin?string

Колонка plugins.needplugin

phpinstall?string

Колонка plugins.phpinstall

phpupgrade?string

Колонка plugins.phpupgrade

phpenable?string

Колонка plugins.phpenable

phpdisable?string

Колонка plugins.phpdisable

phpdelete?string

Колонка plugins.phpdelete

notice?string

Колонка plugins.notice

mnotice?integer

Колонка plugins.mnotice

posi?integer

Колонка plugins.posi

Response Body

`application/json`

curl -X POST "https://example.com/plugin/" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 1}

/upload/

Загрузка файла (multipart)

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Request Body

multipart/form-data

file*string

subdir?string

Response Body

`application/json`

curl -X POST "https://example.com/upload/" \  -F file="string"

{  "url": "/uploads/files/…",  "name": "file.jpg"}

/conversations/

Список переписок

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/conversations/"

{  "data": [    {      "id": 0,      "subject": "string",      "created_at": 0,      "updated_at": 0,      "sender_id": 0,      "recipient_id": 0    }  ]}

/xfields/{scope}/

Каталог доп. полей

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

scope*string

Value in

"post"
"user"

Response Body

`application/json`

curl -X GET "https://example.com/xfields/post/"

{  "data": {    "fields": {      "property1": {        "name": "string",        "description": "string",        "hint": "string",        "group": "string",        "category": "string",        "allow_add_usergroups": "string",        "allow_view_usergroups": "string",        "type": "text",        "min": "string",        "max": "string",        "storage": "string",        "max_files": "string",        "max_size": "string",        "image_sizes": "string",        "image_size": "string",        "image_side": "string",        "image_max_size": "string",        "thumb_size": "string",        "thumb_side": "string",        "max_images": "string",        "files_ext": "string",        "file_max_size": "string",        "condition": "string",        "date_format": "string",        "date_view_format": "string",        "select_separator": "string",        "links_separator": "string",        "not_required": 0,        "default": "string",        "allow_multi": 0,        "use_as_links": 0,        "use_editor": 0,        "safe_mode": 0,        "make_watermark": 0,        "make_thumb": 0,        "use_opengraph": "string",        "is_public": "string",        "date_local": "string",        "date_declension": "string",        "allow_in_news": 0,        "lazy_load": "string"      },      "property2": {        "name": "string",        "description": "string",        "hint": "string",        "group": "string",        "category": "string",        "allow_add_usergroups": "string",        "allow_view_usergroups": "string",        "type": "text",        "min": "string",        "max": "string",        "storage": "string",        "max_files": "string",        "max_size": "string",        "image_sizes": "string",        "image_size": "string",        "image_side": "string",        "image_max_size": "string",        "thumb_size": "string",        "thumb_side": "string",        "max_images": "string",        "files_ext": "string",        "file_max_size": "string",        "condition": "string",        "date_format": "string",        "date_view_format": "string",        "select_separator": "string",        "links_separator": "string",        "not_required": 0,        "default": "string",        "allow_multi": 0,        "use_as_links": 0,        "use_editor": 0,        "safe_mode": 0,        "make_watermark": 0,        "make_thumb": 0,        "use_opengraph": "string",        "is_public": "string",        "date_local": "string",        "date_declension": "string",        "allow_in_news": 0,        "lazy_load": "string"      }    },    "groups": {      "property1": {        "title": "string",        "description": "string"      },      "property2": {        "title": "string",        "description": "string"      }    }  },  "scope": "post"}

Создать определение поля (typed validation)

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

scope*string

Value in

"post"
"user"

Request Body

application/json

Описание одного доп. поля новости (xfields.json → fields.*).

name?string

description?string

hint?string

group?string

category?string

allow_add_usergroups?string

allow_view_usergroups?string

type?string

Value in

"text"
"textarea"
"htmljs"
"select"
"image"
"imagegalery"
"video"
"audio"
"file"
"yesorno"
"datetime"

min?string

max?string

storage?string

max_files?string

max_size?string

image_sizes?string

image_size?string

image_side?string

image_max_size?string

thumb_size?string

thumb_side?string

max_images?string

files_ext?string

file_max_size?string

condition?string

date_format?string

date_view_format?string

select_separator?string

links_separator?string

not_required?integer

default?string

Для select — варианты через \n

allow_multi?integer

use_as_links?integer

use_editor?integer

safe_mode?integer

make_watermark?integer

make_thumb?integer

use_opengraph?string

is_public?string

date_local?string

date_declension?string

allow_in_news?integer

lazy_load?string

Response Body

`application/json`

curl -X POST "https://example.com/xfields/post/" \  -H "Content-Type: application/json" \  -d '{}'

{  "name": "string",  "scope": "string",  "data": {    "name": "string",    "description": "string",    "hint": "string",    "group": "string",    "category": "string",    "allow_add_usergroups": "string",    "allow_view_usergroups": "string",    "type": "text",    "min": "string",    "max": "string",    "storage": "string",    "max_files": "string",    "max_size": "string",    "image_sizes": "string",    "image_size": "string",    "image_side": "string",    "image_max_size": "string",    "thumb_size": "string",    "thumb_side": "string",    "max_images": "string",    "files_ext": "string",    "file_max_size": "string",    "condition": "string",    "date_format": "string",    "date_view_format": "string",    "select_separator": "string",    "links_separator": "string",    "not_required": 0,    "default": "string",    "allow_multi": 0,    "use_as_links": 0,    "use_editor": 0,    "safe_mode": 0,    "make_watermark": 0,    "make_thumb": 0,    "use_opengraph": "string",    "is_public": "string",    "date_local": "string",    "date_declension": "string",    "allow_in_news": 0,    "lazy_load": "string"  }}

/xfields/{scope}/encode

Сериализация значений в формат post.xfields / users.xfields (аналог forPost)

Body: {fields:{name:value}} или {name,value}. Ответ: raw + parsed.

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

scope*string

Value in

"post"
"user"

Request Body

application/json

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/xfields/post/encode" \  -H "Content-Type: application/json" \  -d '{}'

{  "raw": "string",  "parsed": {}}

/xfields/{scope}/{name}

Определение одного поля

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

scope*string

Value in

"post"
"user"

name*string

Query Parameters

as?string

Projection по типу (image, text, …)

Response Body

`application/json`

curl -X GET "https://example.com/xfields/post/string"

{  "data": {    "name": "string",    "description": "string",    "hint": "string",    "group": "string",    "category": "string",    "allow_add_usergroups": "string",    "allow_view_usergroups": "string",    "type": "text",    "min": "string",    "max": "string",    "storage": "string",    "max_files": "string",    "max_size": "string",    "image_sizes": "string",    "image_size": "string",    "image_side": "string",    "image_max_size": "string",    "thumb_size": "string",    "thumb_side": "string",    "max_images": "string",    "files_ext": "string",    "file_max_size": "string",    "condition": "string",    "date_format": "string",    "date_view_format": "string",    "select_separator": "string",    "links_separator": "string",    "not_required": 0,    "default": "string",    "allow_multi": 0,    "use_as_links": 0,    "use_editor": 0,    "safe_mode": 0,    "make_watermark": 0,    "make_thumb": 0,    "use_opengraph": "string",    "is_public": "string",    "date_local": "string",    "date_declension": "string",    "allow_in_news": 0,    "lazy_load": "string"  },  "scope": "string"}

Заменить определение поля

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

scope*string

Value in

"post"
"user"

name*string

Request Body

application/json

Описание одного доп. поля новости (xfields.json → fields.*).

name?string

description?string

hint?string

group?string

category?string

allow_add_usergroups?string

allow_view_usergroups?string

type?string

Value in

"text"
"textarea"
"htmljs"
"select"
"image"
"imagegalery"
"video"
"audio"
"file"
"yesorno"
"datetime"

min?string

max?string

storage?string

max_files?string

max_size?string

image_sizes?string

image_size?string

image_side?string

image_max_size?string

thumb_size?string

thumb_side?string

max_images?string

files_ext?string

file_max_size?string

condition?string

date_format?string

date_view_format?string

select_separator?string

links_separator?string

not_required?integer

default?string

Для select — варианты через \n

allow_multi?integer

use_as_links?integer

use_editor?integer

safe_mode?integer

make_watermark?integer

make_thumb?integer

use_opengraph?string

is_public?string

date_local?string

date_declension?string

allow_in_news?integer

lazy_load?string

Response Body

`application/json`

curl -X PUT "https://example.com/xfields/post/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "name": "myfield",  "updated": true}

Удалить определение поля

Authorization

bearerAuth

AuthorizationBearer <token>

Access token из POST /oauth/token (credential_type или grant_type). Сырой API-ключ на ресурсах не принимается.

In: header

Path Parameters

scope*string

Value in

"post"
"user"

name*string

Response Body

`application/json`

curl -X DELETE "https://example.com/xfields/post/string"

{  "name": "myfield",  "deleted": true}

/health

Проверка API (без Bearer)

Response Body

`application/json`

curl -X GET "https://example.com/health"

{  "version": "200.1.0",  "api": "v2",  "auth": "Bearer"}

Схемы

Компоненты components.schemas из OpenAPI.

AdminLogs

AdminLogs?

Схема таблицы admin_logs.

AdminSections

AdminSections?

Схема таблицы admin_sections.

ApiError

ApiError?

Единый JSON-формат ошибки API v2: error, message, details?

Example

{  "error": "unauthorized",  "message": "Требуется Authorization: Bearer <AuthToken>"}

Banned

Banned?

Схема таблицы banned.

Banners

Banners?

Схема таблицы banners.

BannersLogs

BannersLogs?

Схема таблицы banners_logs.

BannersRubrics

BannersRubrics?

Схема таблицы banners_rubrics.

CommentRatingLog

CommentRatingLog?

Схема таблицы comment_rating_log.

Comments

Comments?

Схема таблицы comments.

CommentsFiles

CommentsFiles?

Схема таблицы comments_files.

Complaint

Complaint?

Схема таблицы complaint.

ConversationReads

ConversationReads?

Схема таблицы conversation_reads.

ConversationUsers

ConversationUsers?

Схема таблицы conversation_users.

Conversations

Conversations?

Схема таблицы conversations.

ConversationsMessages

ConversationsMessages?

Схема таблицы conversations_messages.

DownloadsLog

DownloadsLog?

Схема таблицы downloads_log.

Email

Email?

Схема таблицы email.

Files

Files?

Схема таблицы files.

Flood

Flood?

Схема таблицы flood.

IgnoreList

IgnoreList?

Схема таблицы ignore_list.

Images

Images?

Схема таблицы images.

Links

Links?

Схема таблицы links.

LoginLog

LoginLog?

Схема таблицы login_log.

Logs

Logs?

Схема таблицы logs.

Lostdb

Lostdb?

Схема таблицы lostdb.

MailLog

MailLog?

Схема таблицы mail_log.

Metatags

Metatags?

Схема таблицы metatags.

NewsletterTemplateCategories

NewsletterTemplateCategories?

Схема таблицы newsletter_template_categories.

NewsletterTemplateItems

NewsletterTemplateItems?

Схема таблицы newsletter_template_items.

Notice

Notice?

Схема таблицы notice.

Plugins

Plugins?

Схема таблицы plugins.

PluginsFiles

PluginsFiles?

Схема таблицы plugins_files.

PluginsLogs

PluginsLogs?

Схема таблицы plugins_logs.

Poll

Poll?

Схема таблицы poll.

PollLog

PollLog?

Схема таблицы poll_log.

Post

Post?

Схема таблицы post.

PostExtras

PostExtras?

Схема таблицы post_extras.

PostExtrasCats

PostExtrasCats?

Схема таблицы post_extras_cats.

PostLog

PostLog?

Схема таблицы post_log.

PostPass

PostPass?

Схема таблицы post_pass.

PostXfieldField

PostXfieldField?

Описание одного доп. поля новости (xfields.json → fields.*).

PostXfieldGroup

PostXfieldGroup?

Группа доп. полей новости (xfields.json → groups.*).

PostXfieldsCatalog

PostXfieldsCatalog?

Каталог доп. полей новостей (xfields.json).

Question

Question?

Схема таблицы question.

ReadLog

ReadLog?

Схема таблицы read_log.

Redirects

Redirects?

Схема таблицы redirects.

Rss

Rss?

Схема таблицы rss.

Rssinform

Rssinform?

Схема таблицы rssinform.

Sendlog

Sendlog?

Схема таблицы sendlog.

SocialLogin

SocialLogin?

Схема таблицы social_login.

SpamLog

SpamLog?

Схема таблицы spam_log.

Static

Static?

Схема таблицы static.

StaticFiles

StaticFiles?

Схема таблицы static_files.

Storage

Storage?

Схема таблицы storage.

TableRow

TableRow?||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Тело записи: выберите схему по логическому имени таблицы в path {name} (SchemaRegistry).

Twofactor

Twofactor?

Схема таблицы twofactor.

UserXfieldField

UserXfieldField?

Описание доп. поля профиля (userxfields.json → fields.*).

UserXfieldsCatalog

UserXfieldsCatalog?

Каталог доп. полей профиля (userxfields.json).

Usergroups

Usergroups?

Схема таблицы usergroups.

Users

Users?

Схема таблицы users.

UsersDelete

UsersDelete?

Схема таблицы users_delete.

Views

Views?

Схема таблицы views.

Vote

Vote?

Схема таблицы vote.

VoteResult

VoteResult?

Схема таблицы vote_result.

Xfsearch

Xfsearch?

Схема таблицы xfsearch.

OpenAPI

Операции

/oauth/token

200application/json

400application/json

/.well-known/oauth-authorization-server

200application/json

/me

200application/json

401application/json

/key/check

200application/json

401application/json

/oauth/userinfo

200application/json

401application/json

/oauth/revoke

200application/json

/post/

200application/json

401application/json

201application/json

401application/json

422application/json

/post/{id}

200application/json

401application/json

404application/json

/table/{name}

200application/json

401application/json

404application/json

422application/json

201application/json

401application/json

422application/json

/table/{name}/{id}

200application/json

400application/json

401application/json

404application/json

200application/json

400application/json

401application/json

404application/json

422application/json

200application/json

400application/json

401application/json

404application/json

/user/

201application/json

401application/json

422application/json

/usergroup/

201application/json

401application/json

422application/json

/plugin/

201application/json

401application/json

422application/json

/upload/

201application/json

401application/json

422application/json

/conversations/

200application/json

401application/json

/xfields/{scope}/

200application/json

401application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`