Skip to content

Commit ff46870

Browse files
committed
APIKey: adding usage guide
1 parent 75836be commit ff46870

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

source/includes/internal/_apikey.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,3 +234,40 @@ POST /apikeys/update/<public_key>
234234
* `users/wallets/withdraw-confirm`
235235
* `users/wallets/withdraw-cancel`
236236
*
237+
238+
## استفاده از کلید API
239+
240+
برای استفاده از API باید سه هدر زیر در هر درخواست ارسال شوند:
241+
242+
| Header | توضیح |
243+
|------------------------|----------------------------------------------------------------------|
244+
| `Nobitex-Key` | کلید عمومی تولید شده توسط کاربر |
245+
| `Nobitex-Signature` | امضای محاسبه‌شده با الگوریتم `Ed25519` |
246+
| `Nobitex-Timestamp` | زمان جاری به ثانیه (Unix timestamp) در منطقه زمانی UTC |
247+
248+
### نحوه محاسبه امضا (Signature)
249+
250+
امضا به صورت زیر محاسبه می‌شود:
251+
252+
```shell
253+
signature = base64(Ed25519(timestamp + method + url + body))
254+
```
255+
256+
- **timestamp**: عدد ثانیه‌ای (Unix time) بر اساس UTC
257+
- **method**: متد HTTP درخواست (مانند `GET`, `POST`)
258+
- **url**: مسیر کامل درخواست (endpoint) مانند `/market/orders/list?fromId=123`
259+
- **body**: محتوای خام بدنه درخواست (برای متدهای `POST`، `PUT` و …)
260+
261+
> توجه: مقدار `Nobitex-Key` همان کلید عمومی شماست و باید به صورت ثابت در هدر ارسال شود.
262+
263+
```bash
264+
curl -X POST "https://apiv2.nobitex.ir/orders/cancel-old" \
265+
-H "Content-Type: application/json" \
266+
-H "Nobitex-Key: <Your-Public-Key>" \
267+
-H "Nobitex-Signature: <Generated-Signature>" \
268+
-H "Nobitex-Timestamp: <Unix-Timestamp>" \
269+
-d '{
270+
"order": 27032,
271+
"status": "canceled"
272+
}'
273+
```

0 commit comments

Comments
 (0)