در این قسمت به بررسی وبسرویس اطلاعات یک شخص حقیقی (Person Info API) میپردازیم. این سرویس امکان دریافت اطلاعات مرتبط با یک شخص حقیقی را بر اساس کد ملی فراهم میکند.
این سرویس با دریافت کد ملی یک شخص حقیقی، اطلاعات مربوط به آن شخص شامل نام، جنسیت، سمتهای رسمی، و سایر جزئیات را بازمیگرداند.
نحوه استفاده:
روش درخواست (HTTP Method): GET
آدرس درخواست (Endpoint):
{{baseUrl}}/Person/{{PersonId}}جایگزینهای متغیرها:
{{baseUrl}}: آدرس پایه API (https://api.rasm.io/API){{PersonId}}: کد ملی شخص حقیقی (مثلاً 4900221112)
پارامترهای ورودی:
- PersonId: کد ملی شخص حقیقی. این پارامتر الزامی است.
مثال درخواست:
curl --location --request GET 'https://api.rasm.io/API/Person/4900221112' \
--header 'X-Key: {{XKEY}}'پاسخ نمونه:
در اینجا یک نمونه پاسخ برای دریافت اطلاعات یک شخص حقیقی آورده شده است:
{
"id": 4900221112,
"title": "امیر محبعلی نژاد",
"gender": true,
"tagline": "نپستر",
"importance": 170,
"picture": "4900221112",
"pictureUrl": "https://static.lilak.org/4900221112",
"isValidNationalCode": true,
"companyPerson": [],
"newsPerson": [],
"networkLinks": []
}توضیحات فیلدهای خروجی:
- id: کد ملی شخص.
- title: نام شخص حقیقی.
- gender: جنسیت شخص (
trueبرای مرد وfalseبرای زن). - tagline: توضیحی کوتاه در مورد سمت یا عنوان شخص.
- importance: مقدار اهمیت شخص در سیستم.
- picture: شناسه تصویر شخص.
- pictureUrl: لینک تصویر ثبتشده شخص.
- isValidNationalCode: نشاندهنده صحت کد ملی (در صورت
trueمعتبر است). - companyPerson: اطلاعات سمتهای شخص در شرکتها.
- newsPerson: آگهیهای روزنامه رسمی مرتبط با شخص.
- networkLinks: لینکهای مرتبط با شبکههای ارتباطی شخص.
نکات مهم:
- توضیحات سمتها و آگهیها: اطلاعات مربوط به سمتها و آگهیهای مرتبط با شخص در فیلدهای companyPerson و newsPerson قرار میگیرد که میتوانند لیستهای مرتبط با شرکتها و آگهیها را شامل شوند.
- اعتبار کد ملی: فیلد isValidNationalCode نشاندهنده اعتبار کد ملی است و در صورت نامعتبر بودن، ممکن است خطا رخ دهد.
خطاهای احتمالی:
- 400 Bad Request: پارامتر ورودی کد ملی اشتباه است.
- 404 Not Found: شخصی با کد ملی دادهشده یافت نشد.
- 401 Unauthorized: کلید API اشتباه است یا وجود ندارد.
نتیجهگیری:
در این قسمت، نحوه استفاده از وب سرویس اطلاعات یک شخص حقیقی را بررسی کردیم. این سرویس به شما امکان میدهد تا اطلاعات کاملی از یک شخص حقیقی را بر اساس کد ملی او دریافت کنید.