Skip to content

Commit 9ac237c

Browse files
Better example in README.md
1 parent a20d21e commit 9ac237c

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Robokassa Node.JS
22

3-
Пакет Node.JS для [Robokassa](https://docs.robokassa.ru).
3+
Пакет [Robokassa](https://docs.robokassa.ru) для Node.JS.
44

55
Поддерживает JavaScript и TypeScript.
66

@@ -29,13 +29,16 @@ const robokassa = new Robokassa({
2929
merchantLogin: 'my_merchant_login',
3030
password1: 'my_password_1',
3131
password2: 'my_password_2',
32+
// hashAlgorithm: 'md5' (default)
33+
// isTest: false (default)
34+
// url: 'https://auth.robokassa.ru/Merchant/Index.aspx' (default)
3235
});
3336

3437
const url = robokassa.generatePaymentUrl({
3538
outSum: '10.00',
3639
description: 'Тестовый продукт',
37-
// Пользовательские параметры должны начинаться с "shp_" | "Shp_" | "SHP_".
38-
// Они будут переданы на ваш сервер вызовом Робокассы после оплаты.
40+
// Пользовательские параметры должны начинаться с "shp_" или "Shp_" или "SHP_".
41+
// Они будут переданы на ваш сервер вызовом Робокассы после оплаты в том же виде.
3942
userParameters: {
4043
shp_interface: 'link',
4144
shp_user_id: 'user_id',
@@ -68,7 +71,11 @@ const { Robokassa } = require('@dev-aces/robokassa');
6871

6972
## Webhooks
7073

71-
Если в настройках Робокассы исользуется метод `POST` для отправки рузультатов (рекомендуется), то можно использовать Express.JS для обработки запросов:
74+
Result URL для подтверждения и обработки успешной оплаты.
75+
76+
Для перенаправления браузера пользователя после оплаты Робокасса использует параметры Success URL и Failure URL. Не перепутайте.
77+
78+
Если в настройках Робокассы исользуется метод `POST` для отправки Result URL (рекомендуется), то можно использовать следующий код Express.JS для обработки запросов:
7279

7380
TypeScript:
7481

@@ -84,12 +91,12 @@ const robokassa = new Robokassa({
8491

8592
const app = express();
8693

87-
// Указать данный URL для отправки результатов в настройках Робокассы
94+
// Указать данный URL для отправки успешного результаты оплаты в настройках Робокассы (Method of sending data to Result Url)
8895
app.post('/payment/result', function (req: Request, res: Response) {
8996
const robokassaResponse = req.body as IRobokassaResponse;
9097

9198
if (robokassa.checkPayment(robokassaResponse)) {
92-
console.log('PAYMENT SUCCESS!');
99+
console.log('Successful payment!');
93100

94101
const { InvId, /* OutSum, shp_interface, ...etc */ } = robokassaResponse;
95102

@@ -102,18 +109,6 @@ app.post('/payment/result', function (req: Request, res: Response) {
102109
});
103110
```
104111

105-
Опционально можно добавить webhook APIs для оповещения об успешной и неуспешной оплате.
106-
107-
```typescript
108-
app.get('/payment/true', function (req: Request, res: Response) {
109-
res.render('payment_true');
110-
});
111-
112-
app.get('/payment/false', function (req: Request, res: Response) {
113-
res.render('payment_false');
114-
});
115-
```
116-
117112
## Внесение изменений
118113

119114
Сделайте fork репозитория, изменения, убедитесь что успешно пройдены тесты и форматирование:

0 commit comments

Comments
 (0)