حساب کاربری
تنظیمات حساب
تنظیمات وبسرویس حساب را میخواند یا تغییر میدهد. بدون پارامتر فقط تنظیمات فعلی را برمیگرداند.
GET
POST
https://api.payamras.ir/v1/YOUR_API_KEY/account/config.json
- با debugmode=enabled درخواستهای ارسال اجرا نمیشوند و اعتباری کم نمیشود؛ برای تست یکپارچهسازی مناسب است. یادتان باشد قبل از راهاندازی آن را غیرفعال کنید.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
apilogs
اختیاری
|
String | ثبت لاگ درخواستها: justfaults (فقط خطاها)، enabled یا disabled. |
debugmode
اختیاری
|
String | enabled یا disabled. در حالت enabled ارسال واقعی انجام نمیشود. |
defaultsender
اختیاری
|
String | خط پیشفرض ارسال. |
mincreditalarm
اختیاری
|
Integer | آستانه هشدار کمبود اعتبار به ریال. |
resendfailed
اختیاری
|
String | ارسال مجدد پیامهای ناموفق: enabled یا disabled. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/account/config.json" \
--data-urlencode "debugmode=enabled"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'debugmode' => 'enabled',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/account/config.json?" . http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
if ($result['return']['status'] !== 200) {
throw new RuntimeException($result['return']['message']);
}
const apiKey = "YOUR_API_KEY";
const params = new URLSearchParams({
debugmode: "enabled",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/account/config.json?${params}`);
const result = await response.json();
if (result.return.status !== 200) {
throw new Error(result.return.message);
}
import requests
api_key = "YOUR_API_KEY"
params = {
"debugmode": "enabled",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/account/config.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
apilogs |
String | وضعیت ثبت لاگ. |
dailyreport |
String | وضعیت گزارش روزانه. |
debugmode |
String | وضعیت حالت تست. |
defaultsender |
String | خط پیشفرض. |
mincreditalarm |
Integer | آستانه هشدار اعتبار. |
resendfailed |
String | وضعیت ارسال مجدد. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"apilogs": "justfaults",
"dailyreport": "enabled",
"debugmode": "enabled",
"defaultsender": "10004346",
"mincreditalarm": 500000,
"resendfailed": "enabled"
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند:
- 407 دسترسی به این اطلاعات مجاز نیست.