Перейти к содержимому
WP2WP2

Пакетная сборка / загрузка

POST
/wp-json/wp2lms-pro/embed-packages/v1/batch
curl --request POST \
  --url 'https://example.com/wp-json/wp2lms-pro/embed-packages/v1/batch?blog_id=1' \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "package": { "title": "Курс HTML", "files": { "index.html": "<!doctype html><html lang=\"ru\"><title>Старт</title><h1>Старт</h1></html>", "module-2.html": "<!doctype html><html lang=\"ru\"><title>Модуль 2</title><h1>Модуль 2</h1></html>" } }, "pages": [ { "title": "Старт", "launch_path": "index.html", "slug": "start", "page_status": "publish" }, { "title": "Модуль 2", "launch_path": "module-2.html", "slug": "module-2" } ], "link_replace": true, "page_status": "publish", "alpine": false }'

Создаёт пакет(ы), опционально страницы WordPress и привязки за один запрос (BatchAssembler::run). Это не одиночный POST /packages и не Static Builder сам по себе. Два режима. Если передан объект package — один пакет на всех: дерево package.files / package.html (html → index.html, если в дереве нет index.html/Index.html), затем либо pages[] (новые или существующие WP-страницы с per-page launch_path), либо materialize_all (как materialize-pages). package.title пустой → «HTML package». Статус пакета всегда publish. Если package есть, массив items игнорируется. Иначе нужен непустой items[] (иначе 400 embed_packages_batch_empty): по элементу — свой пакет. create_pages по умолчанию true; link_replace по умолчанию true в обоих режимах. Пустой title элемента → «HTML {n}». build.run при истинном значении пытается запустить AgentBuild; сбой модуля не валит HTTP — сообщение попадает в warnings[], ответ всё равно 201. Нужно manage_network (multisite) или edit_pages. Cookie + X-WP-Nonce или Application Password.

Authorizations

Заголовок раздела «Authorizations»

Parameters

Заголовок раздела «Parameters»

Query Parameters

Заголовок раздела «Query Parameters»
blog_id
integer
>= 1

ID сайта сети (switch_to_blog). Необязательно: по умолчанию текущий блог запроса. Не ID пакета и не page_id. Минимум 1; на одиночном сайте должен совпадать с текущим — иначе 400 embed_packages_invalid_blog. В сети неизвестный сайт или сайт другой сети — 404 embed_packages_unknown_blog.

Example
1

Request Bodyrequired

Заголовок раздела «Request Bodyrequired»
Media typeapplication/json
object
package
object
title

Заголовок общего пакета. Необязательно; пусто → «HTML package». Статус записи всегда publish.

string
html

HTML, который PHP кладёт в files[‘index.html’], если в дереве ещё нет index.html/Index.html.

string
files

Карта относительных путей к содержимому. Ключ — безопасный относительный путь (PackageFilePolicy). Пустой объект PHP не считает деревом. Небезопасный путь — unsafe_path; чужое расширение — disallowed_extension.

object
key
additional properties
One of:

Сырой текст файла (HTML/CSS/JS).

string
pages

Страницы WordPress в режиме общего пакета (объекты, не числа). Если пусто и materialize_all — материализация индекса пакета.

Array<object>
object
title

Заголовок страницы WordPress. Пусто → имя файла из launch_path или «Page {n}».

string
launch_path

Относительный HTML в общем пакете для этой страницы (sanitize как у PagePackageReplace). Не page_id.

string
page_status

Статус этой страницы. Необязательно; иначе body.page_status, иначе publish.

string
Allowed values: publish draft private
slug

post_name. Необязательно; иначе sanitize имени launch_path без расширения.

string
page_id

ID уже существующей страницы WordPress (post_type=page) для wp_update_post вместо insert. Не ID пакета. 0 или не-страница → создаётся новая.

integer
alpine

Alpine на этой странице при link_replace. По умолчанию false.

boolean
items

Режим «пакет на элемент». Игнорируется, если передан объект package. Пустой массив без package — 400 embed_packages_batch_empty.

Array<object>
object
title

Заголовок пакета (и страницы, если create_pages). Пусто → «HTML {n}».

string
html

HTML, который попадает в files[‘index.html’], если такого ключа ещё нет.

string
files

Карта относительных путей к содержимому. Ключ — безопасный относительный путь (PackageFilePolicy). Пустой объект PHP не считает деревом. Небезопасный путь — unsafe_path; чужое расширение — disallowed_extension.

object
key
additional properties
One of:

Сырой текст файла (HTML/CSS/JS).

string
alpine

Alpine при привязке созданной/обновлённой страницы. По умолчанию false.

boolean
launch_path

Override запуска на странице WordPress. Пусто → launch_path из метаданных пакета.

string
page_status

Статус страницы WordPress, если create_pages. По умолчанию publish.

string
Allowed values: publish draft private
slug

post_name страницы WordPress, если create_pages.

string
page_id

ID существующей страницы WordPress для update вместо insert. Не ID пакета.

integer
materialize_all

Только режим package: если pages пуст/нет, вызвать PagesMaterializer. По умолчанию false.

boolean
create_pages

Только режим items: создавать/обновлять страницы WordPress. Необязательно, по умолчанию true.

boolean
link_replace

Сразу PagePackageReplace::save на созданных страницах. Необязательно, по умолчанию true.

boolean
page_status

Дефолтный статус страниц (materialize_all и pages[] без своего page_status). По умолчанию publish.

string
Allowed values: publish draft private
alpine

Alpine для materialize_all в режиме package. По умолчанию false. В pages[]/items[] есть свой alpine.

boolean
build
object
run

Если истинно — после ingest вызвать AgentBuild (BuildService::create + run). Сбой модуля не меняет HTTP-код, текст идёт в warnings[].

boolean
page_ids

Дополнительные ID страниц WordPress к тем, что создал batch. Не ID пакетов.

Array<integer>
title

Course_name сборки. Необязательно, по умолчанию «Agent embed batch».

string
api_type

Api_type сборки. Необязательно, по умолчанию local (sanitize_key).

string
export_mode

Export_mode сборки. Необязательно, по умолчанию package.

string
main_page_id

ID главной страницы WordPress для AgentBuild, если ключ передан.

integer
course_id

Строковый course_id сборки, если ключ передан.

string
version

Версия сборки ((float)), если ключ передан.

number
sync

Второй аргумент BuildService::run($id, $sync). По умолчанию false.

boolean
Example
{
  "package": {
    "title": "Курс HTML",
    "files": {
      "index.html": "<!doctype html><html lang=\"ru\"><title>Старт</title><h1>Старт</h1></html>",
      "module-2.html": "<!doctype html><html lang=\"ru\"><title>Модуль 2</title><h1>Модуль 2</h1></html>"
    }
  },
  "pages": [
    {
      "title": "Старт",
      "launch_path": "index.html",
      "slug": "start",
      "page_status": "publish"
    },
    {
      "title": "Модуль 2",
      "launch_path": "module-2.html",
      "slug": "module-2"
    }
  ],
  "link_replace": true,
  "page_status": "publish",
  "alpine": false
}

Responses

Заголовок раздела «Responses»

201

Заголовок раздела «201»

Сборка выполнена. Режим package — package_id, meta, launch_url, pages[], is_multipage. Режим items — items[]. Всегда blog_id; опционально build и warnings.

Media typeapplication/json

Форма зависит от режима. package — package_id, meta, launch_url, pages, is_multipage. items — items[]. RestApi всегда добавляет blog_id. build — только если build.run сработал без WP_Error; иначе текст в warnings.

object
package_id

ID общего пакета (режим package). В режиме items поля нет.

integer
meta

Полный массив post meta _wp2lms_embed_package (PackageMeta::get). У пакета без ingest — пустой объект.

object
content_type

Тип после ManifestPipeline — web, scorm1.2, scorm2004 или xapi. Пусто, пока содержимое не залито.

string
version

Версия из манифеста (для SCORM часто совпадает с content_type). Для web обычно пустая строка.

string
activity_id

XAPI activity id. Если парсер не дал — {home}wp2lms-embed-package/{id}.

string
launch_path

Относительный HTML запуска внутри storage (из манифеста или fallback index.html).

string
title

Заголовок из launch HTML / манифеста; PHP может перезаписать post_title пакета этим значением.

string
mastery_score

Mastery score из imsmanifest (SCORM), иначе null.

number
nullable
content_tool

Детектор автора: ispring, articulate_rise, articulate_storyline, articulate_presenter, captivate, elucidat или пустая строка.

string
storage_rel

Путь от uploads basedir, wp2lms-embed-packages/{id}/.

string
uploaded_at

Unix-время последней успешной записи содержимого (time() в finalize).

integer
is_multipage

True только для content_type=web без content_tool и ≥2 HTML в индексе.

boolean
pages

Индекс HTML (path+title), если пакет multipage; иначе [].

Array<object>
object
path

Относительный путь HTML внутри каталога пакета (posix, без ведущего /). Из PackagePagesIndex::scan.

string
title

Заголовок из <title> файла или имя без расширения, если тега нет.

string
launch_url

URL запуска общего пакета (режим package).

string format: uri
pages

Страницы WordPress в режиме package (не путать с meta.pages внутри пакета).

Array<object>
object
package_id

ID созданного общего пакета.

integer
page_id

ID страницы WordPress (созданной или обновлённой). Не ID пакета.

integer
title

Заголовок страницы, как записали в batch.

string
slug

Slug, который ушёл в post_name (может быть пустым, если не задавали и не вывели из launch_path).

string
launch_path

Путь запуска страницы (override или дефолт пакета).

string
is_multipage

Копия is_multipage общего пакета (режим package).

boolean
items

Результаты режима items[] (по одному пакету на элемент).

Array<object>
object
package_id

ID пакета, созданного для этого элемента items[].

integer
page_id

ID страницы WordPress либо null, если create_pages=false.

integer
nullable
title

Заголовок элемента (пакет/страница).

string
launch_path

Override или launch_path из meta пакета.

string
launch_url

Абсолютный URL запуска этого пакета.

string format: uri
meta

Полный массив post meta _wp2lms_embed_package (PackageMeta::get). У пакета без ingest — пустой объект.

object
content_type

Тип после ManifestPipeline — web, scorm1.2, scorm2004 или xapi. Пусто, пока содержимое не залито.

string
version

Версия из манифеста (для SCORM часто совпадает с content_type). Для web обычно пустая строка.

string
activity_id

XAPI activity id. Если парсер не дал — {home}wp2lms-embed-package/{id}.

string
launch_path

Относительный HTML запуска внутри storage (из манифеста или fallback index.html).

string
title

Заголовок из launch HTML / манифеста; PHP может перезаписать post_title пакета этим значением.

string
mastery_score

Mastery score из imsmanifest (SCORM), иначе null.

number
nullable
content_tool

Детектор автора: ispring, articulate_rise, articulate_storyline, articulate_presenter, captivate, elucidat или пустая строка.

string
storage_rel

Путь от uploads basedir, wp2lms-embed-packages/{id}/.

string
uploaded_at

Unix-время последней успешной записи содержимого (time() в finalize).

integer
is_multipage

True только для content_type=web без content_tool и ≥2 HTML в индексе.

boolean
pages

Индекс HTML (path+title), если пакет multipage; иначе [].

Array<object>
object
path

Относительный путь HTML внутри каталога пакета (posix, без ведущего /). Из PackagePagesIndex::scan.

string
title

Заголовок из <title> файла или имя без расширения, если тега нет.

string
blog_id

ID сайта после switch. RestApi дописывает всегда.

integer
build

Обёртка AgentBuild { created, run }, если build.run истинно и модуль ответил не WP_Error. Иначе поля нет.

object
key
additional properties
any
warnings

Сообщения (например AgentBuild недоступен). Не меняют HTTP 201.

Array<string>
Example
{
  "package_id": 42,
  "meta": {
    "content_type": "web",
    "version": "",
    "activity_id": "https://lms.example.com/wp2lms-embed-package/42",
    "launch_path": "index.html",
    "title": "Курс HTML",
    "mastery_score": null,
    "content_tool": "",
    "storage_rel": "wp2lms-embed-packages/42/",
    "uploaded_at": 1726252800,
    "is_multipage": true,
    "pages": [
      {
        "path": "index.html",
        "title": "Старт"
      },
      {
        "path": "module-2.html",
        "title": "Модуль 2"
      }
    ]
  },
  "launch_url": "https://lms.example.com/wp-content/uploads/wp2lms-embed-packages/42/index.html",
  "pages": [
    {
      "package_id": 42,
      "page_id": 128,
      "title": "Старт",
      "slug": "start",
      "launch_path": "index.html"
    },
    {
      "package_id": 42,
      "page_id": 129,
      "title": "Модуль 2",
      "slug": "module-2",
      "launch_path": "module-2.html"
    }
  ],
  "is_multipage": true,
  "blog_id": 1
}

400

Заголовок раздела «400»

Embed_packages_batch_empty — нет package-объекта и пустой items[]; embed_packages_batch_package — package не объект; embed_packages_batch_page — pages[n] не объект; embed_packages_batch_item — items[n] не объект; embed_packages_invalid_blog — некорректный blog_id.

Media typeapplication/json
object
code

Код WP_Error (get_error_code()), например embed_packages_not_found.

string
message

Текст WP_Error (get_error_message()).

string
data

Data WP_Error. Обычно { "status": 404 }. Ошибки ingest/materialize без status WordPress REST отдаёт как 500.

object
Example
{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

401

Заголовок раздела «401»

Не аутентифицирован. WordPress REST: rest_forbidden (status 401), если нет cookie-сессии. Cookie + X-WP-Nonce или Application Password.

Media typeapplication/json
object
code

Код WP_Error (get_error_code()), например embed_packages_not_found.

string
message

Текст WP_Error (get_error_message()).

string
data

Data WP_Error. Обычно { "status": 404 }. Ошибки ingest/materialize без status WordPress REST отдаёт как 500.

object
Example
{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

403

Заголовок раздела «403»

Нет права manage_network (multisite) или edit_pages (одиночный сайт), либо невалидный REST nonce (rest_cookie_invalid_nonce).

Media typeapplication/json
object
code

Код WP_Error (get_error_code()), например embed_packages_not_found.

string
message

Текст WP_Error (get_error_message()).

string
data

Data WP_Error. Обычно { "status": 404 }. Ошибки ingest/materialize без status WordPress REST отдаёт как 500.

object
Example
{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

404

Заголовок раздела «404»

Embed_packages_unknown_blog — в сети нет такого сайта или сайт принадлежит другой сети.

Media typeapplication/json
object
code

Код WP_Error (get_error_code()), например embed_packages_not_found.

string
message

Текст WP_Error (get_error_message()).

string
data

Data WP_Error. Обычно { "status": 404 }. Ошибки ingest/materialize без status WordPress REST отдаёт как 500.

object
Example
{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

500

Заголовок раздела «500»

WP_Error без HTTP-status — сбой wp_insert_post/wp_update_post или ingest дерева (empty_tree, unsafe_path, disallowed_extension, process_failed, write_failed и др.). WordPress REST отдаёт такие ошибки как 500.

Media typeapplication/json
object
code

Код WP_Error (get_error_code()), например embed_packages_not_found.

string
message

Текст WP_Error (get_error_message()).

string
data

Data WP_Error. Обычно { "status": 404 }. Ошибки ingest/materialize без status WordPress REST отдаёт как 500.

object
Example
{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}