مای پاتریس روی سایت اختصاصی
با مای پاتریس، مشتری پس از ورود به سایت ماندهحساب و صورتحساب خود در پاتریس را میبیند. پاتریس یار اشخاص و صورتحسابها را به سایت میفرستد و سایت آنها را به مشتری نشان میدهد.
مای پاتریس از چه endpointهایی استفاده میکند؟
| کار | endpoint |
|---|---|
| تست اتصال | GET /patris-yar/mypatris/summary (همین صفحه) |
| اشخاص و ماندهحساب | POST /patris-yar/mypatris/persons |
| صورتحساب هر شخص | POST /patris-yar/mypatris/statements |
| کالاها و قیمتها | POST /patris-yar/products، مشترک با فروشگاه |
مشتری حساب خود را چطور میبیند؟
هر شخص با username شناخته میشود. وقتی مشتری وارد سایت شد، اشخاصی را نشان دهید که username آنها با نام کاربری مشتری یا mobile آنها با موبایل حساب مشتری برابر است. صورتحساب با code شخص پیدا میشود.
پیشنیازها
- مسیرها و احراز هویت
- امکان «مای پاتریس» برای حساب پاتریس فعال باشد.
Endpoint
GET /patris-yar/mypatris/summary
هدرها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
X-Payava-Key | string | بله | کلید API حساب پاتریس. |
نمونه درخواست و پیادهسازی
پاتریس یار هنگام «تست اتصال» در بخش مای پاتریس، اول GET /patris-yar/ping و بعد همین endpoint را صدا میزند. فقط موفق بودن پاسخ مهم است.
- curl
- C#
- Python
- PHP
- Node.js
- Go
curl https://shop.example.com/patris-yar/mypatris/summary \
-H "X-Payava-Key: YOUR_API_KEY"
patris.MapGet("/mypatris/summary", async (IMyPatrisStore store) =>
{
var (persons, statements, lines) = await store.CountsAsync();
return Results.Json(new { ok = true, plugin = "custom-1.0.0", persons, statements, lines });
});
@router.get("/mypatris/summary")
def mypatris_summary():
persons, statements, lines = mypatris_store.counts()
return {"ok": True, "plugin": "custom-1.0.0", "persons": persons, "statements": statements, "lines": lines}
if ($method === 'GET' && $route === '/mypatris/summary') {
[$persons, $statements, $lines] = $myPatris->counts();
respond(200, ['ok' => true, 'plugin' => 'custom-1.0.0', 'persons' => $persons, 'statements' => $statements, 'lines' => $lines]);
}
router.get('/mypatris/summary', async (req, res, next) => {
try {
const { persons, statements, lines } = await myPatrisStore.counts();
res.json({ ok: true, plugin: 'custom-1.0.0', persons, statements, lines });
} catch (err) {
next(err);
}
});
func myPatrisSummary(w http.ResponseWriter, r *http.Request) {
persons, statements, lines := myPatrisStore.Counts(r.Context())
writeJSON(w, http.StatusOK, map[string]any{
"ok": true, "plugin": "custom-1.0.0",
"persons": persons, "statements": statements, "lines": lines,
})
}
// patris.HandleFunc("GET "+base+"/mypatris/summary", myPatrisSummary)
نمونه پاسخ موفق
{ "ok": true, "plugin": "custom-1.0.0", "persons": 120, "statements": 95, "lines": 4310 }
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
ok | boolean | بله | همیشه true. |
plugin | string | خیر | نسخهی پیادهسازی شما. |
persons | integer | خیر | تعداد اشخاص ذخیرهشده. |
statements | integer | خیر | تعداد اشخاصی که صورتحساب دارند. |
lines | integer | خیر | تعداد کل ردیفهای صورتحساب. |
کدهای خطا
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
401 | payava_patris_unauthorized | — | کلید نادرست است. |
404 | — | — | مسیر وجود ندارد. پاتریس یار مای پاتریس را روی این سایت فعال نمیکند. |
نکتهها
اگر فروشگاه اینترنتی و مای پاتریس هر دو به یک سایت وصل باشند، دریافت سفارش را فقط برای یکی از آنها روشن کنید. پاتریس یار این حالت را بررسی نمیکند و اگر هر دو روشن باشند، سفارشها ممکن است بین دو بخش تقسیم شوند یا دو بار به پاتریس برسند.
- صفحهی «حساب من در پاتریس» را فقط به کاربر واردشده نشان دهید. مانده و صورتحساب اطلاعات مالی مشتری است.
- مبلغها به واحد پاتریس هستند. برای نمایش، بر همان ضریب قیمت تقسیم کنید.