WordPress Plugin Docs

OrderReport для WordPress

Это подробная документация по WordPress-плагину OrderReport. Здесь собран полный маршрут: что нужно подготовить в приложении, как установить плагин, где ввести API key, как включить WooCommerce и интеграции форм, как проверить отправку данных и что делать, если что-то не работает.

Что нужно перед началом

  • Активный проект в OrderReport.
  • Добавленный и активный домен сайта в проекте.
  • Активный API key проекта.
  • Доступ администратора WordPress.
  • WooCommerce, если вы хотите синхронизировать заказы магазина.

Что делает плагин

Одна точка интеграции

Плагин подключает WordPress-сайт к вашему пространству OrderReport и умеет отправлять заказы WooCommerce, frontend-события и успешные отправки популярных форм-плагинов.

Что важно знать

API key остаётся на сервере

Плагин отправляет заказы и события через WordPress и не раскрывает API key в браузере посетителя. Это безопаснее и удобнее для production-сайтов.

После настройки

Проверка видна сразу

На странице настроек есть блок диагностики: он показывает последний успешный запрос и последнюю ошибку, поэтому можно быстро понять, дошли ли данные до OrderReport.

1

Шаг

Подготовьте проект в OrderReport

До установки плагина подготовьте проект в самом OrderReport. Это самый важный этап: без активного проекта, домена и API key WordPress-плагин не сможет отправлять данные.

  1. 1

    Создайте или выберите проект

    Откройте OrderReport и создайте новый проект либо выберите уже существующий проект, в который вы хотите отправлять заказы и события с WordPress-сайта.

  2. 2

    Добавьте домен сайта

    Внутри проекта добавьте домен сайта WordPress, например example.com или shop.example.com. Домен должен быть активным, иначе API будет отклонять запросы.

    Если WordPress-сайт отправляет данные сервером, проверка всё равно идёт по Origin. Поэтому домен нужно добавить обязательно.
  3. 3

    Создайте API key

    Создайте API key проекта и сохраните его. Именно этот ключ вы потом вставите в настройки WordPress-плагина.

  4. 4

    Если планируете отслеживать формы, создайте события

    Для форм заранее создайте события в разделе Events и сохраните их keys. Эти keys понадобятся для Contact Form 7, WPForms, Elementor Forms и других интеграций.

Скриншот #1

Проект, домен и API key в интерфейсе OrderReport

Вставьте сюда скриншот, где видно проект, активный домен и место, где пользователь копирует API key.

2

Шаг

Установите и активируйте плагин в WordPress

После подготовки проекта можно установить плагин в WordPress. Если у вас release-архив, установка идёт стандартным способом через загрузку zip-файла.

  1. 1

    Откройте раздел Плагины

    В админке WordPress перейдите в «Плагины» -> «Добавить новый». Если плагин передан вам архивом, используйте кнопку загрузки zip-файла.

  2. 2

    Загрузите архив плагина

    Выберите zip-архив OrderReport и дождитесь завершения установки WordPress.

  3. 3

    Активируйте плагин

    После установки нажмите «Активировать». После активации в админке появится отдельная страница настроек OrderReport.

Скриншот #2

Установка zip-архива через WordPress

Вставьте сюда скриншот экрана «Плагины -> Добавить новый -> Загрузить плагин», чтобы пользователю было легко повторить установку.

3

Шаг

Заполните базовые настройки плагина

После активации откройте страницу OrderReport в админке WordPress и выполните базовую настройку. Это минимальный набор, без которого плагин работать не будет.

  1. 1

    Откройте страницу OrderReport

    В левом меню WordPress откройте пункт OrderReport. На странице вы увидите блок конфигурации, обнаруженные интеграции и диагностику.

  2. 2

    Вставьте API key проекта

    В поле API key вставьте ключ, который вы создали в OrderReport на первом шаге. Затем сохраните настройки.

  3. 3

    Проверьте блок диагностики

    После первых отправок этот блок покажет последний успешный запрос или последнюю ошибку. Если что-то не работает, этот раздел почти всегда помогает понять причину.

    API Base URL в плагине фиксированный. Его не нужно настраивать вручную.
Скриншот #3

Страница настроек OrderReport в WordPress

Вставьте сюда общий скриншот страницы настроек: поле API key, блок диагностики и список интеграций.

4

Шаг

Включите синхронизацию заказов WooCommerce

Если вы используете WooCommerce, плагин может автоматически отправлять заказы в OrderReport. Это серверная интеграция: посетителю сайта ничего дополнительно делать не нужно.

  1. 1

    Включите отправку заказов WooCommerce

    На странице настроек плагина включите опцию синхронизации заказов WooCommerce.

  2. 2

    Выберите отслеживаемые статусы

    Укажите статусы заказа, при достижении которых заказ должен отправляться в OrderReport. Обычно это «Обработка», «Выполнен» или ваш кастомный статус.

  3. 3

    Проверьте состав отправляемых данных

    Плагин отправляет ID заказа, итоговую сумму, валюту, контактные поля клиента, список товаров и дополнительные данные заказа в массиве data.

  4. 4

    Создайте тестовый заказ

    Оформите тестовый заказ на сайте или создайте его в админке WooCommerce и переведите в один из отслеживаемых статусов. После этого заказ должен появиться в OrderReport.

Скриншот #4

Настройка WooCommerce-синхронизации

Вставьте сюда скриншот с включённой опцией отправки WooCommerce-заказов и выбранными статусами.

5

Шаг

Подключите отслеживание форм и событий

Плагин умеет работать как с простыми формами на сайте, так и с популярными WordPress-конструкторами форм. Для них используются события OrderReport.

  1. 1

    Создайте event в OrderReport

    Для каждой логики формы создайте событие в проекте OrderReport и скопируйте его key. Например: lead_form_submitted или callback_request.

  2. 2

    Настройте интеграцию конкретного form plugin

    Откройте нужную форму в Contact Form 7, WPForms, Elementor Forms, Fluent Forms, Forminator или Gravity Forms. Найдите секцию OrderReport, включите интеграцию и укажите event key.

  3. 3

    Для кастомных форм используйте data-orderreport-event

    Если форма написана вручную, добавьте на неё атрибут data-orderreport-event с key события. Frontend bridge плагина автоматически перехватит успешную отправку формы и отправит событие в OrderReport.

  4. 4

    Проверьте, что событие активно

    Если событие выключено в OrderReport, форма у пользователя всё равно должна отправиться, но само событие не будет обработано. Эту ситуацию можно увидеть в диагностике.

Скриншот #5

Настройка event key в форме

Вставьте сюда скриншот экрана одной из поддерживаемых форм, где видно секцию OrderReport и поле event key.

6

Шаг

Проверьте интеграцию от начала до конца

После настройки рекомендуем выполнить простую контрольную проверку. Она занимает несколько минут и помогает убедиться, что проект готов к работе в production.

  1. 1

    Отправьте тестовый заказ или форму

    Сделайте одно контролируемое действие: оформите заказ WooCommerce или отправьте тестовую форму, которую вы привязали к event key.

  2. 2

    Посмотрите страницу OrderReport в WordPress

    Убедитесь, что в блоке диагностики появился последний успешный запрос. Если вместо этого появилась ошибка, откройте её текст и исправьте причину.

  3. 3

    Проверьте интерфейс OrderReport

    Откройте приложение OrderReport и убедитесь, что новый заказ или событие появились в соответствующем разделе.

  4. 4

    Сохраните скриншоты для команды

    После успешной проверки удобно сохранить скриншоты страницы настроек плагина, успешного заказа и успешной отправки формы. Это ускорит onboarding для коллег.

Скриншот #6

Успешная проверка интеграции

Вставьте сюда скриншот, где видно успешный заказ или событие в интерфейсе OrderReport и/или зелёный статус в диагностике WordPress-плагина.

E

Настройка events

Подробная настройка форм по каждому плагину

Выберите form plugin, с которым вы работаете. Для каждого варианта ниже описан точный путь в админке, где включить интеграцию OrderReport, куда вставить event key и что проверить после сохранения.

CF7 Поддерживается

Contact Form 7 -> вкладка OrderReport

В редакторе формы Contact Form 7 появляется отдельная вкладка OrderReport. Внутри неё можно включить интеграцию и указать event key для конкретной формы.

  1. 1

    Откройте форму в Contact Form 7

    Перейдите в админке WordPress в Contact Form 7 и откройте нужную форму на редактирование.

  2. 2

    Перейдите во вкладку OrderReport

    Рядом с основными вкладками формы найдите вкладку OrderReport.

  3. 3

    Включите интеграцию

    Отметьте опцию включения интеграции, чтобы эта форма начала отправлять успешные submit в OrderReport.

  4. 4

    Укажите event key

    В поле event key вставьте ключ активного события из проекта OrderReport и сохраните форму.

Contact Form 7 отправляет событие только после успешной отправки формы. Если событие выключено в OrderReport, сама форма не должна ломаться для посетителя.
Скриншот CF7

Вкладка OrderReport в Contact Form 7

Вставьте сюда скриншот вкладки OrderReport внутри редактора формы CF7, где видно toggle интеграции и поле event key.

Что проверить после настройки

  • Форма сохранена после включения интеграции.
  • Указан правильный event key из проекта.
  • После submit в диагностике появился успешный event-запрос.
WPForms Поддерживается

WPForms -> Settings -> OrderReport

Для WPForms плагин добавляет отдельную секцию OrderReport в настройки формы. Настройка идёт на уровне конкретной формы.

  1. 1

    Откройте форму в WPForms Builder

    Перейдите в WPForms и откройте нужную форму в визуальном builder.

  2. 2

    Перейдите в Settings

    В левой панели откройте раздел Settings формы.

  3. 3

    Откройте секцию OrderReport

    В списке секций настроек найдите отдельный пункт OrderReport.

  4. 4

    Включите интеграцию и задайте event key

    Активируйте OrderReport для этой формы, вставьте event key и сохраните изменения.

Если секция OrderReport не видна сразу, обновите builder целиком. Иногда WPForms не показывает новые секции до полного refresh.
Скриншот WPForms

Настройка OrderReport в WPForms

Вставьте сюда скриншот раздела Settings -> OrderReport в WPForms Builder.

Что проверить после настройки

  • Пункт OrderReport виден в Settings.
  • Интеграция включена у нужной формы.
  • Тестовая отправка формы появилась в OrderReport как event.
Elementor Поддерживается

Elementor Form widget -> Actions After Submit

Для Elementor Forms OrderReport подключается как отдельный action в Actions After Submit. После его выбора появляется секция настройки event key.

  1. 1

    Откройте страницу в Elementor

    Перейдите в Elementor и выберите страницу, на которой используется Form widget.

  2. 2

    Выберите нужный Form widget

    Откройте настройки формы справа в панели Elementor.

  3. 3

    Добавьте action OrderReport

    В поле Actions After Submit выберите OrderReport как одно из действий после отправки формы.

  4. 4

    Заполните event key

    После добавления action появится секция OrderReport. Вставьте туда event key и сохраните страницу.

В Elementor именно action OrderReport запускает отправку. Если action не выбран, event не будет отправляться, даже если форма работает визуально.
Скриншот Elementor

Action OrderReport в Elementor Forms

Вставьте сюда скриншот Form widget, где видно Actions After Submit и секцию OrderReport с полем event key.

Что проверить после настройки

  • OrderReport добавлен в Actions After Submit.
  • Секция OrderReport видна в настройках widget.
  • Event key сохранён вместе со страницей.
Fluent Поддерживается

Fluent Forms -> Settings & Integrations -> OrderReport

Во Fluent Forms для каждой формы добавлен отдельный экран OrderReport. Там включается интеграция и указывается event key.

  1. 1

    Откройте форму во Fluent Forms

    Перейдите в Fluent Forms и выберите форму для редактирования.

  2. 2

    Откройте Settings & Integrations

    В настройках формы перейдите в раздел Settings & Integrations.

  3. 3

    Выберите пункт OrderReport

    В списке доступных внутренних страниц настроек найдите OrderReport.

  4. 4

    Сохраните event key

    Включите интеграцию, вставьте event key и сохраните настройки формы.

Если event key оставить пустым, форма не будет знать, какое именно событие отправлять. Для Fluent Forms ключ нужно явно задать на форме.
Скриншот Fluent Forms

Экран OrderReport в Fluent Forms

Вставьте сюда скриншот страницы OrderReport внутри Settings & Integrations конкретной Fluent Forms формы.

Что проверить после настройки

  • Экран OrderReport доступен внутри формы.
  • Настройки сохранены без ошибок.
  • После успешного submit появилась запись в диагностике.
Forminator Поддерживается

Forminator -> Integrations -> OrderReport

Forminator интегрирован нативно через свой addon API. Сначала OrderReport подключается на странице общих интеграций, затем активируется на уровне конкретной формы.

  1. 1

    Откройте Forminator Integrations

    Перейдите на страницу общих интеграций Forminator и найдите там OrderReport в списке доступных сервисов.

  2. 2

    Проверьте основную конфигурацию

    Forminator использует API key и default event key из главных настроек плагина OrderReport, поэтому отдельно вводить их не нужно.

  3. 3

    Откройте нужную форму

    Перейдите в конкретную Forminator-форму и откройте вкладку Integrations.

  4. 4

    Подключите OrderReport к форме

    Создайте connection OrderReport для формы и при необходимости задайте event key именно для этой формы.

У Forminator два уровня настройки: общий addon и connection внутри формы. Если подключён только addon, но нет connection у формы, событие не уйдёт.
Скриншот Forminator

OrderReport в Forminator Integrations

Вставьте сюда скриншот страницы Integrations или connection-настройки формы, где видно OrderReport и поле event key.

Что проверить после настройки

  • OrderReport виден на общей странице Integrations.
  • У конкретной формы создан connection OrderReport.
  • У connection задан event key или используется глобальный default.
Gravity Поддерживается

Gravity Forms -> Form Settings -> OrderReport

В Gravity Forms плагин добавляет секцию OrderReport прямо в нативные настройки формы. Там можно включить интеграцию и ввести event key.

  1. 1

    Откройте форму в Gravity Forms

    Перейдите в Gravity Forms и выберите форму, которую хотите связать с OrderReport.

  2. 2

    Перейдите в Form Settings

    Откройте стандартные настройки формы через Settings -> Form Settings.

  3. 3

    Найдите секцию OrderReport

    Прокрутите страницу настроек до блока OrderReport.

  4. 4

    Включите интеграцию и вставьте event key

    Активируйте интеграцию, вставьте event key и сохраните настройки формы.

Если event key оставить пустым, разумно заранее настроить глобальный default event key в основном плагине. Тогда Gravity Forms сможет использовать его как fallback.
Скриншот Gravity Forms

Секция OrderReport в Gravity Forms

Вставьте сюда скриншот Form Settings, где видно блок OrderReport и настройки event key.

Что проверить после настройки

  • Секция OrderReport появилась в Form Settings.
  • Интеграция включена у нужной формы.
  • После submit событие видно в OrderReport.
Custom Frontend bridge

Кастомные формы через data-orderreport-event

Если вы не используете готовый forms plugin, можно подключить простую HTML-форму через frontend bridge плагина. Для этого достаточно добавить специальный атрибут с event key.

  1. 1

    Добавьте data-orderreport-event на форму

    На тег form добавьте атрибут data-orderreport-event="your_event_key".

  2. 2

    Убедитесь, что у полей есть name

    Плагин собирает данные через FormData, поэтому у input/select/textarea должны быть корректные name-атрибуты.

  3. 3

    Используйте submit-кнопку

    Для автоматического перехвата отправки лучше использовать button type="submit" или input type="submit".

  4. 4

    Проверьте логи браузера

    В DevTools можно увидеть логи плагина с префиксом [OrderReport], если нужно понять, собрался ли payload и ушёл ли запрос.

Если использовать input type="button" вместо submit, нативный submit формы не произойдёт, и автотрекинг не сработает.
Скриншот Custom Form

Пример HTML-формы с data-orderreport-event

Вставьте сюда скриншот HTML-примера или браузерного DevTools, где видно форму с data-orderreport-event и успешный лог отправки.

Что проверить после настройки

  • На форме есть data-orderreport-event.
  • У полей формы заполнены атрибуты name.
  • Форма отправляется через submit, а не просто по клику произвольной кнопки.