first commit

This commit is contained in:
Matvey Ryabchikov
2022-04-18 18:46:07 +03:00
commit 6ae6220a56
4 changed files with 71 additions and 0 deletions

9
AUTHORIZATION.md Normal file
View File

@@ -0,0 +1,9 @@
# Аутентификация для API сайтов СП
## Получение токена и ID карты
Для использования API вам надо знать ID и токен для карты, с которой вы хотите совершить действие. Получить их можно в секции "Поделиться картой" на сайте.
## Аутентификация
Направляя любые запросы к API, добавляйте хедер "Authorization" имеющий форму "Bearer КЛОЧ", где КЛЮЧ - base64 закодированная строка "ID:TOKEN", где ID - ID вашей карты, и TOKEN - токен от нее.

28
PAYMENTS.md Normal file
View File

@@ -0,0 +1,28 @@
# Как встроить оплату АРами на свой сайт / приложение
## Аутентификация
Все запросы, о которых говориться в этом документе должны иметь корректный хедер "Authorization", подробнее [тут](AUTHORIZATION.md)
## Создание запроса на оплату
Чтобы принять оплату АРами, надо сначала создать запрос на оплату. Он делается таким запросом
```
POST https://spworlds.ru/api/public/payment
```
В теле запроса должен быть JSON-объект, содержащий
- `amount` - Стоимость покупки в АРах
- `redirectUrl` - URL страницы, на которую попадет пользователь после оплаты
- `webhookUrl` - URL, куда наш сервер направит запрос, чтобы оповестить ваш сервер об успешной оплате
- `data` - Строка до 100 символов, сюда можно пометить любые полезные данных.
Ответ будет в фотмате JSON и будет содержать только
- `url` - Ссылка на страницу оплаты, на которую стоит перенаправить пользователя.
## Получение данных об успешной оплате
После успешной оплаты наш сервер отправит POST запрос по URL, который вы указали при создании запроса на оплату (webhookUrl).

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
# Документация API сайтов СП
## Вступление
Мы даем API бесплатно всем игрокам. Не надо досить наш сервер десятками запросов в секунду. Так вы испортите качество API для себя и для всех. Спасибо за понимание.
## Предупреждение
API может в любой момент измениться и это ваша задача следить за его изменениями, и подстраивать под них свои приложения.
## Читать далее
1. [Авторизация](AUTHORIZATION.md)
2. [Как встроить оплату АРами на свой сайт / приложение](PAYMENTS.md)
3. [Как переводить деньги с карты при помощи API](TRANSACTIONS.md)

19
TRANSACTIONS.md Normal file
View File

@@ -0,0 +1,19 @@
# Как переводить деньги с карты при помощи API
## Аутентификация
Все запросы, о которых говориться в этом документе должны иметь корректный хедер "Authorization", подробнее [тут](AUTHORIZATION.md)
## Переводы
Чтобы совершить перевод надо сделать подобный запрос
```
POST https://spworlds.ru/api/public/transactions
```
Тело - JSON объект, содержащий:
- `receiver` - Строка, номер карты получателя
- `amount` - Количество аров для перевода
- `comment` - Комментарий для переаода