feat: paygw_moneta 1.0.0, MONETA.Assistant payment gateway for Moodle
This commit is contained in:
@@ -1,93 +1,155 @@
|
||||
# Moodle
|
||||
# 🌟 Платёжный модуль Moneta для [Moodle](https://moodle.org/)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
> **© Правообладатель:** НКО «МОНЕТА» (ООО)
|
||||
|
||||
## Getting started
|
||||
> **📦 Версия модуля: 1.0.0**
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
> **ℹ️ Требования:**
|
||||
> PHP 8.1+
|
||||
> Payment API Moodle 4.3+
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
> **ℹ️ Примечание по валюте:**
|
||||
> Данный модуль работает **только с валютой RUB (Российский рубль)**. Использование других валют не поддерживается.
|
||||
|
||||
## Add your files
|
||||
> Стоимость курса в `enrol_fee` должна быть задана в рублях, иначе платежный модуль **"Moneta"** не будет предложен.
|
||||
|
||||
* [Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
|
||||
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
||||
## 🚀 Установка и настройка модуля
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://git.moneta.ru:8000/products/cashier/cms/Moodle.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
### 1. 📥 Скачайте модуль
|
||||
|
||||
## Integrate with your tools
|
||||
[Архив последнего релиза](https://git.pub.moneta.ru/CMS/Moodle/releases/latest) — файл
|
||||
`paygw_moneta-<версия>.zip` в разделе «Файлы» релиза. Внутри архива — папка `moneta`,
|
||||
распаковывать его не нужно.
|
||||
|
||||
* [Set up project integrations](https://git.moneta.ru:8000/products/cashier/cms/Moodle/-/settings/integrations)
|
||||
> ⚠️ Не берите «Исходный код (ZIP)» / «Исходный код (TAR.GZ)» — их сервис добавляет к
|
||||
> каждому релизу автоматически, и корневая папка в них названа не `moneta`. Если такой
|
||||
> архив всё же скачан, при установке (шаг 2) нажмите **«Показать больше…»** и в поле
|
||||
> **«Переименовать корневой каталог»** укажите `moneta`.
|
||||
|
||||
## Collaborate with your team
|
||||
### 2. 📂 Установите плагин
|
||||
|
||||
* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
|
||||
* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
|
||||
* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
|
||||
* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
|
||||
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
||||
**Через интерфейс Moodle** (нужны права администратора сайта):
|
||||
|
||||
## Test and Deploy
|
||||
1. **Администрирование → Плагины → Установка плагинов**.
|
||||
2. Добавьте архив в поле **«ZIP-пакет»** одним из способов:
|
||||
- перетащите файл в поле;
|
||||
- или нажмите **«Выберите файл...»**, в открывшемся окне выберите **«Загрузить файл»**,
|
||||
укажите архив на компьютере и нажмите **«Загрузить этот файл»**.
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
Затем нажмите **«Установить плагин из ZIP-файла»**. Moodle сам определит тип плагина
|
||||
(платёжный шлюз) и папку назначения.
|
||||
3. Нажмите **«Продолжить»** на странице проверки, затем **«Обновить Moodle»** — создастся
|
||||
таблица заказов и шлюз Moneta включится автоматически.
|
||||
|
||||
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
|
||||
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
|
||||
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
|
||||
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
|
||||
* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
|
||||
**Вручную** (если установка из ZIP отключена на сервере): распакуйте архив так, чтобы
|
||||
получилась папка `payment/gateway/moneta` в корне Moodle (в Moodle 5.1 и новее —
|
||||
`public/payment/gateway/moneta`), и откройте **Администрирование → Уведомления**,
|
||||
чтобы завершить установку.
|
||||
|
||||
***
|
||||
### 3. ✅ Проверьте, что включено нужное
|
||||
|
||||
# Editing this README
|
||||
1. **Администрирование → Плагины → Платежные шлюзы → Управление платежными шлюзами** —
|
||||
у **Moneta** включён значок видимости.
|
||||
2. **Администрирование → Плагины → Способы зачисления → Управление способами зачисления** —
|
||||
включён способ **«Зачисление за оплату»** (штатный плагин Moodle `enrol_fee`, через него
|
||||
курсы продаются).
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
### 4. 💳 Создайте платёжный счёт Moodle и подключите к нему Moneta
|
||||
|
||||
## Suggestions for a good README
|
||||
1. **Администрирование → Платежи → Платежные счета → Создать платежный счет** —
|
||||
придумайте название (например, номер вашего счёта MONETA.RU) и сохраните.
|
||||
2. В строке счёта, в списке его шлюзов, нажмите **Монета**, включите шлюз и
|
||||
заполните реквизиты по таблице ниже.
|
||||
3. Скопируйте **URL для уведомлений** кнопкой «Скопировать в буфер обмена» — он понадобится в
|
||||
личном кабинете MONETA.RU.
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
### 5. 🎓 Назначьте цену курсу
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
В курсе: **Участники → Способы зачисления на курс → Добавить способ →
|
||||
Зачисление за оплату**. Укажите **Платежный счет** (созданный на шаге 4),
|
||||
**Оплата за зачисление** (цену) и валюту **RUB**, сохраните.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
**Название способа** заполнять не обязательно. Если его задать, в Moodle 5.x оно
|
||||
заменит заголовок «Для зачисления на этот курс требуется оплата» на странице
|
||||
записи на курс; в списке способов зачисления его видят преподаватели. На оплату
|
||||
не влияет: в чеке и на странице перехода к оплате всегда полное название курса.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
Студент увидит на странице курса кнопку оплаты, выберет **Moneta**, проверит
|
||||
курс и сумму на странице перехода к оплате и нажмёт **«Оплатить»**. После
|
||||
подтверждения оплаты от MONETA.RU доступ к курсу открывается автоматически.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
### 6. 🧪 Проверьте оплату
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
Для проверки без реальных денег используйте **Сервер платежей: Демо** со
|
||||
счётом на [demo.moneta.ru](https://demo.moneta.ru/) и оплатите курс от имени
|
||||
студента. Заказы и причины отказов видны в **Администрирование → Платежи →
|
||||
Заказы Монета**. Покупатель получает сообщения «Ссылка на оплату» и «Оплата
|
||||
принята» по своим настройкам уведомлений (веб-уведомление и/или письмо, если
|
||||
на сайте настроена исходящая почта).
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
### Обновление
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
Скачайте новый архив и установите его так же, как в шаге 2 (Moodle предложит
|
||||
заменить текущую версию), либо замените папку `payment/gateway/moneta` вручную
|
||||
и откройте **Администрирование → Уведомления**. Настройки счетов и заказы
|
||||
сохраняются.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
### Реквизиты шлюза в платёжном аккаунте
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
| Поле | Значение |
|
||||
|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **Номер счёта** | Обязательно. Ваш номер расширенного счёта в системе [MONETA.RU](https://moneta.ru/) |
|
||||
| **Код проверки целостности данных** | Обязательно. Код проверки целостности данных, указанный в настройках расширенного счёта в системе [MONETA.RU](https://moneta.ru/) |
|
||||
| **Сервер платежей** | `Боевой` (по умолчанию) / `Демо` (demo.moneta.ru, отдельный номер счёта) |
|
||||
| **Тестовый режим** | Должен совпадать с флагом «Тестовый режим» в настройках счёта |
|
||||
| **Email для чеков** | Обязательно. Подставляется в чек, если у покупателя нет ни email, ни телефона — чек придёт на этот адрес, а ФИО покупателя в чеке сохранится |
|
||||
| **Фискализация чеков** | Фискализация чеков по 54-ФЗ средствами системы [MONETA.RU](https://moneta.ru/) сервисом [kassa.payanyway.ru](https://kassa.payanyway.ru/) |
|
||||
| **Ставка НДС** | Ставка для позиции «доступ к курсу» в чеке |
|
||||
| **Отправлять ссылку оплаты на почту** | При создании заказа покупателю приходит сообщение со ссылкой на оплату — можно оплатить позже (по умолчанию включено) |
|
||||
| **URL для уведомлений** | `https://<сайт>/payment/gateway/moneta/callback.php` — его нужно указать в настройках расширенного счёта `Check URL` / `Pay URL` в системе [MONETA.RU](https://moneta.ru/) |
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
## 🔧 Настройка счёта в личном кабинете [MONETA.RU](https://moneta.ru/)
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
1. 📝 [Зарегистрируйтесь](https://moneta.ru/partnerRegistration.htm) в платёжной системе MONETA.RU и заполните все
|
||||
необходимые данные. Дождитесь проверки аккаунта и создайте **расширенный счет**.
|
||||
2. ⚙️ Заполните настройки расширенного счета (раздел **«Мой счет» → «Управление счетами» → «Редактировать счет» →
|
||||
«Показать дополнительные поля»**):
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
| Параметр | Значение |
|
||||
|------------------------------------------|------------------------------------------------------|
|
||||
| **Псевдоним** | `Монета` |
|
||||
| **Тестовый режим** | `Нет` |
|
||||
| **Check URL** | `https://<сайт>/payment/gateway/moneta/callback.php` |
|
||||
| **Pay URL** | `https://<сайт>/payment/gateway/moneta/callback.php` |
|
||||
| **HTTP метод (PayUrl, CheckUrl)** | `GET` / `POST` |
|
||||
| **Код проверки целостности данных** | `ваш_код` (произвольный набор символов) |
|
||||
| **Подпись формы оплаты обязательна** | `Да` |
|
||||
| **Можно переопределять настройки в url** | `Да` |
|
||||
| **Success URL** | Оставить пустым |
|
||||
| **Fail URL** | Оставить пустым |
|
||||
| **InProgress URL** | Оставить пустым |
|
||||
| **Return URL** | Оставить пустым |
|
||||
| **Target (возврат для iframe)** | Оставить пустым |
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
> ⚠️ **Важно!** Для кириллического домена PayURL и CheckURL должны быть указаны в кодировке [Punycode](https://2ip.ru/punycode/).
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
3. Для фискализации чеков по 54-ФЗ средствами за рамками **Moodle**, настройте вашу кассу в сервисе [kassa.payanyway.ru](https://kassa.payanyway.ru),
|
||||
в настройках Вашего расширенного счёта в системе [MONETA.RU](https://moneta.ru/) установите Pay URL: https://kassa.payanyway.ru/index.php?do=invoicepayurl,
|
||||
а в настройках кассы в сервисе [kassa.payanyway.ru](https://kassa.payanyway.ru) пропишите ссылку на Pay URL Вашего интернет-магазина.
|
||||
В этом случае будет пробиваться чек по 54-ФЗ через сервис [kassa.payanyway.ru]([kassa.payanyway.ru](https://kassa.payanyway.ru)), а запрос на Pay URL
|
||||
магазина будет проходить транзитом через сервис [kassa.payanyway.ru](https://kassa.payanyway.ru).
|
||||
|
||||
---
|
||||
|
||||
## 📚 Полезные ресурсы
|
||||
|
||||
- [Документация Moodle](https://docs.moodle.org/)
|
||||
- [Документация Moneta](https://docs.moneta.ru/)
|
||||
|
||||
---
|
||||
|
||||
**✅ Модуль настроен, приятных платежей!** 💰🎉
|
||||
Reference in New Issue
Block a user