دریافت اشخاص و ماندهحساب
پاتریس یار اشخاصی را که در پاتریس برای مای پاتریس تعریف شدهاند، با POST /wp-json/payava-patris/v1/mypatris/persons به سایت میفرستد. هر شخص با username شناخته میشود و سایت آن را ذخیره یا جایگزین میکند.
پیشنیازها
- مای پاتریس در افزونهی اختصاصی وردپرس
- یک جدول اشخاص با کلید اصلی
username.
Endpoint
POST /wp-json/payava-patris/v1/mypatris/persons
هدرها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
X-Payava-Key | string | بله | کلید API حساب پاتریس. |
Content-Type | string | بله | application/json; charset=utf-8 |
پارامترها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
persons | array | بله | اشخاص تغییرکرده. ممکن است خالی باشد. |
deleted | string[] | بله | username اشخاصی که در پاتریس حذف شدهاند. ممکن است خالی باشد. |
فیلدهای هر شخص
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
username | string | بله | نام کاربری شخص در مای پاتریس. شخص بدون username را ذخیره نکنید. |
code | integer | بله | کد حساب شخص در پاتریس. صورتحساب با همین کد ارسال میشود. |
name | string | خیر | نام شخص. |
mobile | string | خیر | موبایل شخص. |
tel | string | خیر | تلفن ثابت. |
address | string | خیر | نشانی. |
email | string | خیر | ایمیل. |
role | string | خیر | نقش شخص در مای پاتریس. |
debtor | number | بله | ماندهحساب، به واحد پاتریس. مثبت یعنی بدهکار، منفی یعنی بستانکار، صفر یعنی بیحساب. |
credit_limit | number | بله | سقف اعتبار، به واحد پاتریس. |
is_lock | boolean | بله | true یعنی حساب شخص در پاتریس قفل است. |
national_code | string | خیر | کد ملی. |
پیادهسازی در وردپرس
جدول اشخاص (هنگام فعالسازی افزونه)
register_activation_hook(__FILE__, function () {
global $wpdb;
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
$charset = $wpdb->get_charset_collate();
dbDelta("CREATE TABLE {$wpdb->prefix}my_patris_persons (
username varchar(191) NOT NULL,
code bigint(20) NOT NULL DEFAULT 0,
name varchar(255) NOT NULL DEFAULT '',
mobile varchar(20) NOT NULL DEFAULT '',
debtor decimal(19,2) NOT NULL DEFAULT 0,
credit_limit decimal(19,2) NOT NULL DEFAULT 0,
is_lock tinyint(1) NOT NULL DEFAULT 0,
data longtext NULL,
updated_at datetime NOT NULL,
PRIMARY KEY (username),
KEY code (code),
KEY mobile (mobile)
) {$charset};");
});
POST /mypatris/persons
function my_patris_mypatris_persons(WP_REST_Request $request)
{
global $wpdb;
$table = $wpdb->prefix . 'my_patris_persons';
$deleted = 0;
foreach ((array) $request->get_param('deleted') as $username) { // deleted first
$deleted += (int) $wpdb->delete($table, ['username' => (string) $username]);
}
$stored = 0;
foreach ((array) $request->get_param('persons') as $p) {
$username = sanitize_text_field((string) ($p['username'] ?? ''));
if ($username === '') {
continue;
}
$wpdb->replace($table, [
'username' => $username,
'code' => (int) ($p['code'] ?? 0),
'name' => sanitize_text_field((string) ($p['name'] ?? '')),
'mobile' => sanitize_text_field((string) ($p['mobile'] ?? '')),
'debtor' => (float) ($p['debtor'] ?? 0),
'credit_limit' => (float) ($p['credit_limit'] ?? 0),
'is_lock' => !empty($p['is_lock']) ? 1 : 0,
'data' => wp_json_encode($p), // tel, address, email, role, national_code
'updated_at' => current_time('mysql', true),
]);
$stored++;
}
return ['stored' => $stored, 'deleted' => $deleted];
}
نمونه پاسخ موفق
200 OK
{ "stored": 1, "deleted": 1 }
پاتریس یار مقدارهای پاسخ را نمیخواند. فقط موفق بودن پاسخ مهم است.
کدهای خطا
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
401 | payava_patris_unauthorized | — | کلید نادرست است. |
400 | invalid_json | — | بدنهی درخواست JSON معتبر نیست. |
نکتهها
- اول
deletedو بعدpersonsرا پردازش کنید. اگر یکusernameدر هر دو آمد، شخص باید باقی بماند. usernameناشناخته درdeletedرا بدون خطا رد کنید.- موبایل را پیش از ذخیره به شکل
09xxxxxxxxxیکسان کنید تا با موبایل حساب مشتری تطبیق پیدا کند. - کد ملی و ماندهحساب اطلاعات حساس هستند. آنها را فقط به خود شخص نشان دهید.