oblodai 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- oblodai-1.0.0/.env.example +9 -0
- oblodai-1.0.0/.github/workflows/ci.yml +19 -0
- oblodai-1.0.0/.github/workflows/release.yml +22 -0
- oblodai-1.0.0/.gitignore +8 -0
- oblodai-1.0.0/CHANGELOG.md +16 -0
- oblodai-1.0.0/LICENSE +21 -0
- oblodai-1.0.0/PKG-INFO +259 -0
- oblodai-1.0.0/README.md +228 -0
- oblodai-1.0.0/RELEASING.md +13 -0
- oblodai-1.0.0/pyproject.toml +49 -0
- oblodai-1.0.0/src/oblodai/__init__.py +38 -0
- oblodai-1.0.0/src/oblodai/_http.py +255 -0
- oblodai-1.0.0/src/oblodai/_transport.py +138 -0
- oblodai-1.0.0/src/oblodai/client.py +184 -0
- oblodai-1.0.0/src/oblodai/errors.py +78 -0
- oblodai-1.0.0/src/oblodai/models.py +227 -0
- oblodai-1.0.0/src/oblodai/py.typed +0 -0
- oblodai-1.0.0/src/oblodai/resources/__init__.py +1 -0
- oblodai-1.0.0/src/oblodai/resources/async_resources.py +215 -0
- oblodai-1.0.0/src/oblodai/resources/sync_resources.py +232 -0
- oblodai-1.0.0/src/oblodai/signing.py +52 -0
- oblodai-1.0.0/src/oblodai/webhooks.py +99 -0
- oblodai-1.0.0/tests/test_client.py +229 -0
- oblodai-1.0.0/tests/test_signing.py +96 -0
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Учётные данные Oblodai. ТОЛЬКО для серверной среды — секрет никогда не должен попадать
|
|
2
|
+
# в браузер или мобильное приложение. Скопируйте в `.env` и подставьте свои значения.
|
|
3
|
+
|
|
4
|
+
# Обязательные:
|
|
5
|
+
OBLODAI_PUBLIC_ID=oblodai_public_id_here
|
|
6
|
+
OBLODAI_SECRET=oblodai_secret_here
|
|
7
|
+
|
|
8
|
+
# Необязательно — переопределяет базовый URL API (по умолчанию https://api.oblodai.com):
|
|
9
|
+
# OBLODAI_BASE_URL=https://api.oblodai.com
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches: [main]
|
|
5
|
+
pull_request:
|
|
6
|
+
jobs:
|
|
7
|
+
test:
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
strategy:
|
|
10
|
+
matrix:
|
|
11
|
+
python-version: ['3.9', '3.11', '3.13']
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
- uses: actions/setup-python@v5
|
|
15
|
+
with:
|
|
16
|
+
python-version: ${{ matrix.python-version }}
|
|
17
|
+
- run: python -m pip install --upgrade pip
|
|
18
|
+
- run: pip install -e ".[dev]"
|
|
19
|
+
- run: pytest
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Publishes 'oblodai' to PyPI on a v* tag.
|
|
2
|
+
# Required repo secret: PYPI_API_TOKEN (PyPI API token).
|
|
3
|
+
# Alternatively configure PyPI Trusted Publishing (OIDC) and drop the password line.
|
|
4
|
+
name: Release
|
|
5
|
+
on:
|
|
6
|
+
push:
|
|
7
|
+
tags: ['v*']
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
jobs:
|
|
11
|
+
publish:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- uses: actions/setup-python@v5
|
|
16
|
+
with:
|
|
17
|
+
python-version: '3.11'
|
|
18
|
+
- run: python -m pip install build
|
|
19
|
+
- run: python -m build
|
|
20
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
|
21
|
+
with:
|
|
22
|
+
password: ${{ secrets.PYPI_API_TOKEN }}
|
oblodai-1.0.0/.gitignore
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Значимые изменения этого пакета. Формат — [Keep a Changelog](https://keepachangelog.com/ru/1.1.0/),
|
|
4
|
+
версии — [SemVer](https://semver.org/lang/ru/).
|
|
5
|
+
|
|
6
|
+
## [1.0.0] — 2026-07-12
|
|
7
|
+
|
|
8
|
+
### Добавлено
|
|
9
|
+
- Первый релиз официального Python SDK для платёжного шлюза Oblodai.
|
|
10
|
+
- Приём платежей, выплаты и массовые выплаты, статические кошельки, возвраты, вебхуки,
|
|
11
|
+
публичные справочники (курсы валют, каталог монет и сетей).
|
|
12
|
+
- Подпись запросов HMAC-SHA256 и проверка подписи вебхуков (сравнение в постоянном времени,
|
|
13
|
+
защита от replay).
|
|
14
|
+
- Конструктор из переменных окружения `OblodaiClient.from_env()` — `OBLODAI_PUBLIC_ID` / `OBLODAI_SECRET` /
|
|
15
|
+
`OBLODAI_BASE_URL`.
|
|
16
|
+
- Автоматические повторы с экспоненциальным backoff и учётом заголовка `Retry-After` на 429.
|
oblodai-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Oblodai
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
oblodai-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: oblodai
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Официальный Python SDK для платёжного шлюза Oblodai: приём платежей, выплаты, статические кошельки, вебхуки.
|
|
5
|
+
Project-URL: Homepage, https://github.com/oblodai/oblodai-python
|
|
6
|
+
Project-URL: Repository, https://github.com/oblodai/oblodai-python
|
|
7
|
+
Project-URL: Documentation, https://github.com/oblodai/oblodai-python#readme
|
|
8
|
+
Project-URL: Issues, https://github.com/oblodai/oblodai-python/issues
|
|
9
|
+
Author: Oblodai
|
|
10
|
+
License-Expression: MIT
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: crypto,cryptocurrency,oblodai,payment-gateway,payments,payout,usdt,webhook
|
|
13
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
+
Classifier: Typing :: Typed
|
|
23
|
+
Requires-Python: >=3.9
|
|
24
|
+
Requires-Dist: httpx>=0.24
|
|
25
|
+
Requires-Dist: pydantic>=2.0
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
|
|
28
|
+
Requires-Dist: pytest>=7; extra == 'dev'
|
|
29
|
+
Requires-Dist: respx>=0.20; extra == 'dev'
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
|
|
32
|
+
# Oblodai Python SDK
|
|
33
|
+
|
|
34
|
+
Официальный Python SDK для платёжного шлюза **Oblodai**: приём платежей, выплаты, статические
|
|
35
|
+
кошельки, вебхуки. Синхронный и асинхронный клиенты, подпись запросов, разбор ответов в
|
|
36
|
+
pydantic-модели, типизированные ошибки и автоматические повторы.
|
|
37
|
+
|
|
38
|
+
> **Базовый URL.** По умолчанию — `https://api.oblodai.com`. При необходимости переопределите `base_url` и свои ключи при инициализации.
|
|
39
|
+
|
|
40
|
+
## Установка
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install oblodai
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Требуется Python 3.9+. Зависимости: `httpx`, `pydantic>=2`.
|
|
47
|
+
|
|
48
|
+
## Учётные данные
|
|
49
|
+
|
|
50
|
+
Рекомендуется хранить ключи в переменных окружения (см. `.env.example`), а не в коде:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
export OBLODAI_PUBLIC_ID=oblodai_...
|
|
54
|
+
export OBLODAI_SECRET=oblodai_live_...
|
|
55
|
+
# необязательно:
|
|
56
|
+
export OBLODAI_BASE_URL=https://api.oblodai.com
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
```python
|
|
60
|
+
from oblodai import OblodaiClient
|
|
61
|
+
|
|
62
|
+
client = OblodaiClient.from_env() # читает OBLODAI_PUBLIC_ID / OBLODAI_SECRET / OBLODAI_BASE_URL
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Быстрый старт (синхронно)
|
|
66
|
+
|
|
67
|
+
```python
|
|
68
|
+
from oblodai import OblodaiClient
|
|
69
|
+
|
|
70
|
+
# либо явно (эквивалент from_env выше):
|
|
71
|
+
client = OblodaiClient(
|
|
72
|
+
public_id="oblodai_...",
|
|
73
|
+
secret="oblodai_live_...",
|
|
74
|
+
base_url="https://api.oblodai.com", # укажите реальный
|
|
75
|
+
)
|
|
76
|
+
|
|
77
|
+
payment = client.payments.create(
|
|
78
|
+
amount="10",
|
|
79
|
+
currency="USD",
|
|
80
|
+
order_id="order-1",
|
|
81
|
+
to_currency="USDT",
|
|
82
|
+
network="tron",
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
print(payment.address) # адрес для оплаты
|
|
86
|
+
print(payment.url) # hosted-страница оплаты
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Асинхронно
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
import asyncio
|
|
93
|
+
from oblodai import AsyncOblodaiClient
|
|
94
|
+
|
|
95
|
+
async def main():
|
|
96
|
+
async with AsyncOblodaiClient(public_id="...", secret="...") as client:
|
|
97
|
+
payment = await client.payments.create(
|
|
98
|
+
amount="10", currency="USD", order_id="order-1",
|
|
99
|
+
to_currency="USDT", network="tron",
|
|
100
|
+
)
|
|
101
|
+
print(payment.address)
|
|
102
|
+
|
|
103
|
+
asyncio.run(main())
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Синхронный клиент тоже поддерживает контекст-менеджер (`with OblodaiClient(...) as client:`).
|
|
107
|
+
|
|
108
|
+
## Проверка вебхуков
|
|
109
|
+
|
|
110
|
+
Подпись вебхука отличается от подписи запроса — SDK делает и то, и другое. Для входящих вебхуков
|
|
111
|
+
берите **сырое тело** и заголовки `X-Webhook-Timestamp` / `X-Webhook-Signature`.
|
|
112
|
+
|
|
113
|
+
```python
|
|
114
|
+
from flask import Flask, request
|
|
115
|
+
from oblodai import construct_event, OblodaiSignatureError
|
|
116
|
+
|
|
117
|
+
app = Flask(__name__)
|
|
118
|
+
WEBHOOK_SECRET = "b7c1e9..." # из client.webhooks.register()
|
|
119
|
+
|
|
120
|
+
@app.post("/oblodai/callback")
|
|
121
|
+
def callback():
|
|
122
|
+
raw = request.get_data() # СЫРОЕ тело — не пересериализовывать
|
|
123
|
+
|
|
124
|
+
# Пробные тела (is_test) не подписаны
|
|
125
|
+
import json
|
|
126
|
+
if json.loads(raw).get("is_test"):
|
|
127
|
+
return "ok", 200
|
|
128
|
+
|
|
129
|
+
try:
|
|
130
|
+
event = construct_event(
|
|
131
|
+
WEBHOOK_SECRET,
|
|
132
|
+
raw,
|
|
133
|
+
request.headers, # проверит подпись И свежесть (replay-защита)
|
|
134
|
+
)
|
|
135
|
+
except OblodaiSignatureError:
|
|
136
|
+
return "bad signature", 403
|
|
137
|
+
|
|
138
|
+
if event["type"] == "payment" and event["status"] == "paid":
|
|
139
|
+
# пометить заказ event["order_id"] оплаченным (идемпотентно по uuid + status)
|
|
140
|
+
pass
|
|
141
|
+
return "ok", 200
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
`construct_event` и `verify_webhook` по умолчанию проверяют свежесть в окне 5 минут
|
|
145
|
+
(`max_age_seconds=300`). Передайте `max_age_seconds=0`, чтобы отключить.
|
|
146
|
+
|
|
147
|
+
## Обработка ошибок
|
|
148
|
+
|
|
149
|
+
Все ошибки API — экземпляры `OblodaiAPIError` с машиночитаемым `.code`. Ветвитесь по коду.
|
|
150
|
+
|
|
151
|
+
```python
|
|
152
|
+
from oblodai import OblodaiAPIError
|
|
153
|
+
|
|
154
|
+
try:
|
|
155
|
+
client.payouts.create(
|
|
156
|
+
amount="25", currency="USDT", network="tron",
|
|
157
|
+
address="T...", order_id="payout-1",
|
|
158
|
+
)
|
|
159
|
+
except OblodaiAPIError as e:
|
|
160
|
+
if e.code == "payout.insufficient_funds":
|
|
161
|
+
... # недостаточно средств
|
|
162
|
+
elif e.code == "payout.funds_maturing":
|
|
163
|
+
... # средства ещё дозревают — временно, e.is_retriable == True
|
|
164
|
+
print(e.code, e.status, e.message)
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Классы ошибок
|
|
168
|
+
|
|
169
|
+
| Класс | Когда |
|
|
170
|
+
|---|---|
|
|
171
|
+
| `OblodaiAPIError` | API вернул конверт `error`. Есть `.code`, `.status`, `.is_retriable`. |
|
|
172
|
+
| `OblodaiConnectionError` | Сеть недоступна. |
|
|
173
|
+
| `OblodaiTimeoutError` | Истёк таймаут запроса. |
|
|
174
|
+
| `OblodaiSignatureError` | Не прошла проверка подписи вебхука. |
|
|
175
|
+
| `OblodaiError` | Базовый класс для всех выше. |
|
|
176
|
+
|
|
177
|
+
## Повторы (retry)
|
|
178
|
+
|
|
179
|
+
Временные ошибки (`5xx`, `429`, `payout.funds_maturing`, сетевые сбои) повторяются автоматически с
|
|
180
|
+
экспоненциальным backoff и джиттером. Ошибки запроса (`4xx`) не повторяются.
|
|
181
|
+
|
|
182
|
+
```python
|
|
183
|
+
from oblodai import OblodaiClient, RetryConfig
|
|
184
|
+
|
|
185
|
+
client = OblodaiClient(
|
|
186
|
+
public_id="...", secret="...",
|
|
187
|
+
retry=RetryConfig(max_attempts=4, initial_delay=0.5, max_delay=30.0),
|
|
188
|
+
# retry=None — отключить
|
|
189
|
+
)
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
> **Важно про таймаут.** Таймаут не означает, что операция не прошла. Благодаря идемпотентности по
|
|
193
|
+
> `order_id` повтор безопасен: если выплата уже создана — вернётся она же, дубля не будет.
|
|
194
|
+
|
|
195
|
+
## Обзор методов
|
|
196
|
+
|
|
197
|
+
```python
|
|
198
|
+
# Платежи
|
|
199
|
+
client.payments.create(amount=..., currency=..., order_id=..., ...)
|
|
200
|
+
client.payments.info(order_id="order-1")
|
|
201
|
+
client.payments.history(limit=25, offset=0, status="paid")
|
|
202
|
+
client.payments.services()
|
|
203
|
+
client.payments.qr(order_id="order-1")
|
|
204
|
+
client.payments.resend(order_id="order-1")
|
|
205
|
+
client.payments.refund(order_id="order-1", address="T...", amount="10")
|
|
206
|
+
client.payments.set_accepted([...]) / list_accepted()
|
|
207
|
+
client.payments.set_discount(...) / list_discounts()
|
|
208
|
+
client.payments.set_accuracy(...) / get_accuracy()
|
|
209
|
+
client.payments.set_autorefund(...) / get_autorefund()
|
|
210
|
+
|
|
211
|
+
# Выплаты
|
|
212
|
+
client.payouts.create(amount=..., currency=..., address=..., order_id=...)
|
|
213
|
+
client.payouts.create_mass([...])
|
|
214
|
+
client.payouts.info(order_id="payout-1")
|
|
215
|
+
client.payouts.history(...)
|
|
216
|
+
client.payouts.services()
|
|
217
|
+
client.payouts.calculate(...)
|
|
218
|
+
client.payouts.approve(uuid)
|
|
219
|
+
client.payouts.refund(...)
|
|
220
|
+
client.payouts.get_fee_config() / set_fee_config(bool)
|
|
221
|
+
client.payouts.get_refund_fee_config() / set_refund_fee_config(bool)
|
|
222
|
+
|
|
223
|
+
# Кошельки
|
|
224
|
+
client.wallets.create(currency="USDT", network="tron", order_id="client-42")
|
|
225
|
+
client.wallets.block(address="T...")
|
|
226
|
+
client.wallets.blocked_address_refund(uuid="...", address="T...")
|
|
227
|
+
client.wallets.qr("T...")
|
|
228
|
+
|
|
229
|
+
# Аккаунт
|
|
230
|
+
client.account.balance()
|
|
231
|
+
client.account.referral()
|
|
232
|
+
client.account.transfer_to_personal(amount="50", currency="USDT")
|
|
233
|
+
client.account.vrcs(enabled=True)
|
|
234
|
+
|
|
235
|
+
# Вебхуки
|
|
236
|
+
client.webhooks.register("https://...")
|
|
237
|
+
client.webhooks.deliveries()
|
|
238
|
+
client.webhooks.test_payment(url_callback="https://...")
|
|
239
|
+
|
|
240
|
+
# Настройки
|
|
241
|
+
client.settings.list_auto_withdraw() / set_auto_withdraw(...) / delete_auto_withdraw(currency)
|
|
242
|
+
client.settings.list_allowlist() / add_allowlist(cidr) / remove_allowlist(cidr) / enable_allowlist(bool)
|
|
243
|
+
|
|
244
|
+
# Курсы (публично, без ключа)
|
|
245
|
+
client.rates.list("ETH")
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Асинхронный клиент имеет те же методы — с `await`.
|
|
249
|
+
|
|
250
|
+
## Замечания
|
|
251
|
+
|
|
252
|
+
- **Суммы — строки** в единицах валюты (`"25.00"`), не числа. Так сохраняется точность.
|
|
253
|
+
- **`order_id`/`reference` — ваш ключ идемпотентности.** Задавайте всегда для платежей и выплат.
|
|
254
|
+
- **Секрет — только на сервере.** SDK серверный; не встраивайте ключ в клиентские приложения.
|
|
255
|
+
- **Модели игнорируют неописанные поля** — дополнительные поля в ответе API не сломают разбор.
|
|
256
|
+
|
|
257
|
+
## Лицензия
|
|
258
|
+
|
|
259
|
+
MIT
|
oblodai-1.0.0/README.md
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# Oblodai Python SDK
|
|
2
|
+
|
|
3
|
+
Официальный Python SDK для платёжного шлюза **Oblodai**: приём платежей, выплаты, статические
|
|
4
|
+
кошельки, вебхуки. Синхронный и асинхронный клиенты, подпись запросов, разбор ответов в
|
|
5
|
+
pydantic-модели, типизированные ошибки и автоматические повторы.
|
|
6
|
+
|
|
7
|
+
> **Базовый URL.** По умолчанию — `https://api.oblodai.com`. При необходимости переопределите `base_url` и свои ключи при инициализации.
|
|
8
|
+
|
|
9
|
+
## Установка
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pip install oblodai
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Требуется Python 3.9+. Зависимости: `httpx`, `pydantic>=2`.
|
|
16
|
+
|
|
17
|
+
## Учётные данные
|
|
18
|
+
|
|
19
|
+
Рекомендуется хранить ключи в переменных окружения (см. `.env.example`), а не в коде:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
export OBLODAI_PUBLIC_ID=oblodai_...
|
|
23
|
+
export OBLODAI_SECRET=oblodai_live_...
|
|
24
|
+
# необязательно:
|
|
25
|
+
export OBLODAI_BASE_URL=https://api.oblodai.com
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
```python
|
|
29
|
+
from oblodai import OblodaiClient
|
|
30
|
+
|
|
31
|
+
client = OblodaiClient.from_env() # читает OBLODAI_PUBLIC_ID / OBLODAI_SECRET / OBLODAI_BASE_URL
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Быстрый старт (синхронно)
|
|
35
|
+
|
|
36
|
+
```python
|
|
37
|
+
from oblodai import OblodaiClient
|
|
38
|
+
|
|
39
|
+
# либо явно (эквивалент from_env выше):
|
|
40
|
+
client = OblodaiClient(
|
|
41
|
+
public_id="oblodai_...",
|
|
42
|
+
secret="oblodai_live_...",
|
|
43
|
+
base_url="https://api.oblodai.com", # укажите реальный
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
payment = client.payments.create(
|
|
47
|
+
amount="10",
|
|
48
|
+
currency="USD",
|
|
49
|
+
order_id="order-1",
|
|
50
|
+
to_currency="USDT",
|
|
51
|
+
network="tron",
|
|
52
|
+
)
|
|
53
|
+
|
|
54
|
+
print(payment.address) # адрес для оплаты
|
|
55
|
+
print(payment.url) # hosted-страница оплаты
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Асинхронно
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
import asyncio
|
|
62
|
+
from oblodai import AsyncOblodaiClient
|
|
63
|
+
|
|
64
|
+
async def main():
|
|
65
|
+
async with AsyncOblodaiClient(public_id="...", secret="...") as client:
|
|
66
|
+
payment = await client.payments.create(
|
|
67
|
+
amount="10", currency="USD", order_id="order-1",
|
|
68
|
+
to_currency="USDT", network="tron",
|
|
69
|
+
)
|
|
70
|
+
print(payment.address)
|
|
71
|
+
|
|
72
|
+
asyncio.run(main())
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Синхронный клиент тоже поддерживает контекст-менеджер (`with OblodaiClient(...) as client:`).
|
|
76
|
+
|
|
77
|
+
## Проверка вебхуков
|
|
78
|
+
|
|
79
|
+
Подпись вебхука отличается от подписи запроса — SDK делает и то, и другое. Для входящих вебхуков
|
|
80
|
+
берите **сырое тело** и заголовки `X-Webhook-Timestamp` / `X-Webhook-Signature`.
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
from flask import Flask, request
|
|
84
|
+
from oblodai import construct_event, OblodaiSignatureError
|
|
85
|
+
|
|
86
|
+
app = Flask(__name__)
|
|
87
|
+
WEBHOOK_SECRET = "b7c1e9..." # из client.webhooks.register()
|
|
88
|
+
|
|
89
|
+
@app.post("/oblodai/callback")
|
|
90
|
+
def callback():
|
|
91
|
+
raw = request.get_data() # СЫРОЕ тело — не пересериализовывать
|
|
92
|
+
|
|
93
|
+
# Пробные тела (is_test) не подписаны
|
|
94
|
+
import json
|
|
95
|
+
if json.loads(raw).get("is_test"):
|
|
96
|
+
return "ok", 200
|
|
97
|
+
|
|
98
|
+
try:
|
|
99
|
+
event = construct_event(
|
|
100
|
+
WEBHOOK_SECRET,
|
|
101
|
+
raw,
|
|
102
|
+
request.headers, # проверит подпись И свежесть (replay-защита)
|
|
103
|
+
)
|
|
104
|
+
except OblodaiSignatureError:
|
|
105
|
+
return "bad signature", 403
|
|
106
|
+
|
|
107
|
+
if event["type"] == "payment" and event["status"] == "paid":
|
|
108
|
+
# пометить заказ event["order_id"] оплаченным (идемпотентно по uuid + status)
|
|
109
|
+
pass
|
|
110
|
+
return "ok", 200
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
`construct_event` и `verify_webhook` по умолчанию проверяют свежесть в окне 5 минут
|
|
114
|
+
(`max_age_seconds=300`). Передайте `max_age_seconds=0`, чтобы отключить.
|
|
115
|
+
|
|
116
|
+
## Обработка ошибок
|
|
117
|
+
|
|
118
|
+
Все ошибки API — экземпляры `OblodaiAPIError` с машиночитаемым `.code`. Ветвитесь по коду.
|
|
119
|
+
|
|
120
|
+
```python
|
|
121
|
+
from oblodai import OblodaiAPIError
|
|
122
|
+
|
|
123
|
+
try:
|
|
124
|
+
client.payouts.create(
|
|
125
|
+
amount="25", currency="USDT", network="tron",
|
|
126
|
+
address="T...", order_id="payout-1",
|
|
127
|
+
)
|
|
128
|
+
except OblodaiAPIError as e:
|
|
129
|
+
if e.code == "payout.insufficient_funds":
|
|
130
|
+
... # недостаточно средств
|
|
131
|
+
elif e.code == "payout.funds_maturing":
|
|
132
|
+
... # средства ещё дозревают — временно, e.is_retriable == True
|
|
133
|
+
print(e.code, e.status, e.message)
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Классы ошибок
|
|
137
|
+
|
|
138
|
+
| Класс | Когда |
|
|
139
|
+
|---|---|
|
|
140
|
+
| `OblodaiAPIError` | API вернул конверт `error`. Есть `.code`, `.status`, `.is_retriable`. |
|
|
141
|
+
| `OblodaiConnectionError` | Сеть недоступна. |
|
|
142
|
+
| `OblodaiTimeoutError` | Истёк таймаут запроса. |
|
|
143
|
+
| `OblodaiSignatureError` | Не прошла проверка подписи вебхука. |
|
|
144
|
+
| `OblodaiError` | Базовый класс для всех выше. |
|
|
145
|
+
|
|
146
|
+
## Повторы (retry)
|
|
147
|
+
|
|
148
|
+
Временные ошибки (`5xx`, `429`, `payout.funds_maturing`, сетевые сбои) повторяются автоматически с
|
|
149
|
+
экспоненциальным backoff и джиттером. Ошибки запроса (`4xx`) не повторяются.
|
|
150
|
+
|
|
151
|
+
```python
|
|
152
|
+
from oblodai import OblodaiClient, RetryConfig
|
|
153
|
+
|
|
154
|
+
client = OblodaiClient(
|
|
155
|
+
public_id="...", secret="...",
|
|
156
|
+
retry=RetryConfig(max_attempts=4, initial_delay=0.5, max_delay=30.0),
|
|
157
|
+
# retry=None — отключить
|
|
158
|
+
)
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
> **Важно про таймаут.** Таймаут не означает, что операция не прошла. Благодаря идемпотентности по
|
|
162
|
+
> `order_id` повтор безопасен: если выплата уже создана — вернётся она же, дубля не будет.
|
|
163
|
+
|
|
164
|
+
## Обзор методов
|
|
165
|
+
|
|
166
|
+
```python
|
|
167
|
+
# Платежи
|
|
168
|
+
client.payments.create(amount=..., currency=..., order_id=..., ...)
|
|
169
|
+
client.payments.info(order_id="order-1")
|
|
170
|
+
client.payments.history(limit=25, offset=0, status="paid")
|
|
171
|
+
client.payments.services()
|
|
172
|
+
client.payments.qr(order_id="order-1")
|
|
173
|
+
client.payments.resend(order_id="order-1")
|
|
174
|
+
client.payments.refund(order_id="order-1", address="T...", amount="10")
|
|
175
|
+
client.payments.set_accepted([...]) / list_accepted()
|
|
176
|
+
client.payments.set_discount(...) / list_discounts()
|
|
177
|
+
client.payments.set_accuracy(...) / get_accuracy()
|
|
178
|
+
client.payments.set_autorefund(...) / get_autorefund()
|
|
179
|
+
|
|
180
|
+
# Выплаты
|
|
181
|
+
client.payouts.create(amount=..., currency=..., address=..., order_id=...)
|
|
182
|
+
client.payouts.create_mass([...])
|
|
183
|
+
client.payouts.info(order_id="payout-1")
|
|
184
|
+
client.payouts.history(...)
|
|
185
|
+
client.payouts.services()
|
|
186
|
+
client.payouts.calculate(...)
|
|
187
|
+
client.payouts.approve(uuid)
|
|
188
|
+
client.payouts.refund(...)
|
|
189
|
+
client.payouts.get_fee_config() / set_fee_config(bool)
|
|
190
|
+
client.payouts.get_refund_fee_config() / set_refund_fee_config(bool)
|
|
191
|
+
|
|
192
|
+
# Кошельки
|
|
193
|
+
client.wallets.create(currency="USDT", network="tron", order_id="client-42")
|
|
194
|
+
client.wallets.block(address="T...")
|
|
195
|
+
client.wallets.blocked_address_refund(uuid="...", address="T...")
|
|
196
|
+
client.wallets.qr("T...")
|
|
197
|
+
|
|
198
|
+
# Аккаунт
|
|
199
|
+
client.account.balance()
|
|
200
|
+
client.account.referral()
|
|
201
|
+
client.account.transfer_to_personal(amount="50", currency="USDT")
|
|
202
|
+
client.account.vrcs(enabled=True)
|
|
203
|
+
|
|
204
|
+
# Вебхуки
|
|
205
|
+
client.webhooks.register("https://...")
|
|
206
|
+
client.webhooks.deliveries()
|
|
207
|
+
client.webhooks.test_payment(url_callback="https://...")
|
|
208
|
+
|
|
209
|
+
# Настройки
|
|
210
|
+
client.settings.list_auto_withdraw() / set_auto_withdraw(...) / delete_auto_withdraw(currency)
|
|
211
|
+
client.settings.list_allowlist() / add_allowlist(cidr) / remove_allowlist(cidr) / enable_allowlist(bool)
|
|
212
|
+
|
|
213
|
+
# Курсы (публично, без ключа)
|
|
214
|
+
client.rates.list("ETH")
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
Асинхронный клиент имеет те же методы — с `await`.
|
|
218
|
+
|
|
219
|
+
## Замечания
|
|
220
|
+
|
|
221
|
+
- **Суммы — строки** в единицах валюты (`"25.00"`), не числа. Так сохраняется точность.
|
|
222
|
+
- **`order_id`/`reference` — ваш ключ идемпотентности.** Задавайте всегда для платежей и выплат.
|
|
223
|
+
- **Секрет — только на сервере.** SDK серверный; не встраивайте ключ в клиентские приложения.
|
|
224
|
+
- **Модели игнорируют неописанные поля** — дополнительные поля в ответе API не сломают разбор.
|
|
225
|
+
|
|
226
|
+
## Лицензия
|
|
227
|
+
|
|
228
|
+
MIT
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Releasing
|
|
2
|
+
|
|
3
|
+
This package (`oblodai`) is published to **PyPI** by CI when a `v*` tag is pushed.
|
|
4
|
+
|
|
5
|
+
## Setup (one-time)
|
|
6
|
+
**Repo secret:** `PYPI_API_TOKEN` — a PyPI API token. (Or configure PyPI **Trusted Publishing / OIDC** and remove the `password:` line — the workflow already requests `id-token: write`.)
|
|
7
|
+
|
|
8
|
+
## Cut a release
|
|
9
|
+
1. Bump `version` in `pyproject.toml`.
|
|
10
|
+
2. `git tag vX.Y.Z && git push origin vX.Y.Z`.
|
|
11
|
+
3. The **Release** workflow builds sdist+wheel and uploads to PyPI.
|
|
12
|
+
|
|
13
|
+
CI (build + tests) runs on every push and pull request via `.github/workflows/ci.yml`.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "oblodai"
|
|
7
|
+
version = "1.0.0"
|
|
8
|
+
description = "Официальный Python SDK для платёжного шлюза Oblodai: приём платежей, выплаты, статические кошельки, вебхуки."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
authors = [{ name = "Oblodai" }]
|
|
13
|
+
keywords = ["oblodai", "crypto", "payments", "payout", "cryptocurrency", "usdt", "webhook", "payment-gateway"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 5 - Production/Stable",
|
|
16
|
+
"Intended Audience :: Developers",
|
|
17
|
+
"Programming Language :: Python :: 3",
|
|
18
|
+
"Programming Language :: Python :: 3.9",
|
|
19
|
+
"Programming Language :: Python :: 3.10",
|
|
20
|
+
"Programming Language :: Python :: 3.11",
|
|
21
|
+
"Programming Language :: Python :: 3.12",
|
|
22
|
+
"Programming Language :: Python :: 3.13",
|
|
23
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
24
|
+
"Typing :: Typed",
|
|
25
|
+
]
|
|
26
|
+
dependencies = [
|
|
27
|
+
"httpx>=0.24",
|
|
28
|
+
"pydantic>=2.0",
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
[project.urls]
|
|
32
|
+
Homepage = "https://github.com/oblodai/oblodai-python"
|
|
33
|
+
Repository = "https://github.com/oblodai/oblodai-python"
|
|
34
|
+
Documentation = "https://github.com/oblodai/oblodai-python#readme"
|
|
35
|
+
Issues = "https://github.com/oblodai/oblodai-python/issues"
|
|
36
|
+
|
|
37
|
+
[project.optional-dependencies]
|
|
38
|
+
dev = [
|
|
39
|
+
"pytest>=7",
|
|
40
|
+
"pytest-asyncio>=0.23",
|
|
41
|
+
"respx>=0.20",
|
|
42
|
+
]
|
|
43
|
+
|
|
44
|
+
[tool.hatch.build.targets.wheel]
|
|
45
|
+
packages = ["src/oblodai"]
|
|
46
|
+
|
|
47
|
+
[tool.pytest.ini_options]
|
|
48
|
+
asyncio_mode = "auto"
|
|
49
|
+
testpaths = ["tests"]
|