مقدمه

این سرویس با دریافت کد تصویر گواهینامه جدید مشخصات آنرا استخراج مینماید.

فعالسازی سرویس

ارسال درخواست در سایت پادیوم www.podium.ir  :

ابتدا وارد سایت پادیوم شده ، سپس در بازارچه ی API ، سرویسهای مورد نظر خود را انتخاب و درخواست استفاده از آن مجموعه سرویس را ارسال کنید.

clasor

درخواست شما توسط کارشناسان پادیوم، بررسی شده و بعد از تایید آن می‌توانید از طربق پنل کسب و کار خود اقدام به دریافت کلید اتصال مربوط به آن سرویس نمایید.

clasor

منو: پنل کسب و کار – منوی میزکار سرویس گیرنده – درخواستهای ارسالی – در بخش مربوط به سرویس مورد نظر با کلیک بر روی "جزئیات درخواست"

درلیست باز شده با کلیک بر روی تصویر کلید سمت چپ هر سطر جدول می‌توانید ApiKey مربوط به آن سرویس را دریافت و ذخیره کنید.

لینک پنل کسب و کار                                                                                                                                                                                     https://panel.pod.ir/Businesses/Requestwebservices

clasor

نکته : این کلید در تمام درخواست‌های ارسالی از آن سرویس ، ثابت است تا زمانی که کلید جدیدی برای آن سرویس دریافت نشود و به محض دریافت مقدار جدید برای سرویس مورد نظر, کلید قبلی منقضی خواهد شد.

-این کلید در فیلد scApiKey در بخش body درخواست HTTP ، استفاده می شود.

clasor

دریافت کلیدهای سرویس یک (دسته/مجموعه) سرویس در قالب یک فایل:

بعداز فشردن دکمه ی تایید سرویس در پنجره باز شده بالا ، برای تمامی سرویسهای موجود در پنل می‌توانید از گزینه "دریافت فایل خروجی"، لیست کاملی از سرویس‌ها و کلیدهای scApiKey متناظر با هر یک را دریافت کنید.

clasor

clasor

سرویس دریافت اطلاعات تصویر گواهینامه جدید

نکته مهم : در پارامتر تصویر ارسالی ، اطلاعات اولیه موجود در رشته (data:image/jpeg;base64,) نباید ارسال شود و در غیر این صورت پاسخ سرویس، خطای 502 خواهد بود.

  • شناسه سرویس : 1882594

  • پارامتر ورودی سرویس

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

Body

Json

اجباری

پارامتر درخواست

  • مشخصات پارامتر درخواست (Body):

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

Image

string

اجباری

تصویر (به صورت base64_encode )

 

  • پارامتر های خروجی :

نام پارامتر

نوع

توضیحات

hasError

bool

نشاندهندهی این است که  آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر.

messageId

int

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

شناسهی درخواست در پلتفرم پاد.

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجهی فراخوانی سرویس در این آبجکت نمایش داده میشود که در ادامه شرح داده خواهد شد.

 

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

به صورت دقیقتر، بدنهی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است:

پارامتر های پاسخ سرویس در Result :

json

 

  • مشخصات پارامتر پاسخ:

نام پارامتر

نوع

توضیحات

Status

String

کد پاسخ سرویس طبق جدول پاسخ های انتهای مستند

Message

String

پیام سرویس

Data

json

NationalId: شماره ملی

Name: نام

BirthDate: تاریخ تولد

IssueDate: تاریخ صدور

DrivingLicenseNumber: شماره گواهینامه

Period: تاریخ اعتبار

 

  • جدول خروجی ناموفق:

نام پارامتر

نوع

توضیحات

Status

Int

کد پاسخ سرویس طبق جدول پاسخ های انتهای مستند

Message

String

پیام خطا

 

سرویس دریافت اطلاعات تصویر کارت خودرو

این سرویس با دریافت کد تصویر کارت خودرو جدید مشخصات آنرا استخراج مینماید.

نکته مهم : در پارامتر تصویر ارسالی ، اطلاعات اولیه موجود در رشته (data:image/jpeg;base64,) نباید ارسال شود و در غیر این صورت پاسخ سرویس، خطای 502 خواهد بود.

  • شناسه سرویس : 1882625

  • پارامتر ورودی سرویس

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

Body

Json

اجباری

پارامتر درخواست

  • مشخصات پارامتر درخواست (Body):

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

Image

string

اجباری

تصویر (به صورت base64_encode )

 

  • پارامتر های خروجی 

نام پارامتر

نوع

توضیحات

hasError

bool

نشاندهندهی این است که  آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر.

messageId

int

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

شناسهی درخواست در پلتفرم پاد.

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجهی فراخوانی سرویس در این آبجکت نمایش داده میشود که در ادامه شرح داده خواهد شد.

 

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

به صورت دقیقتر، بدنهی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است:

پارامتر های پاسخ سرویس در Result :

json

 

  • مشخصات پارامتر پاسخ:

نام پارامتر

نوع

توضیحات

Status

String

کد پاسخ سرویس طبق جدول پاسخ های انتهای مستند

Message

String

پیام سرویس

Data

json

OwnerName: نام مالک خودرو

OwnerNationalId: شماره ملی مالک خودرو

VIN: شماره خودرو

Part1: بخش عددی سمت چپ پلاک

Part2: حرف پلاک

Part3: بخش عددی میانی پلاک

Part4: بخش عددی سمت راست پلاک

 

  • جدول خروجی ناموفق

نام پارامتر

نوع

توضیحات

Status

Int

کد پاسخ سرویس طبق جدول پاسخ های انتهای مستند

Message

String

پیام خطا

  • سرویس پلاک خودرو - خواندن پلاک خودرو

این سرویس با دریافت کد تصویر کارت خودرو جدید مشخصات آنرا استخراج مینماید.

نکته مهم : در پارامتر تصویر ارسالی ، اطلاعات اولیه موجود در رشته (data:image/jpeg;base64,) نباید ارسال شود و در غیر این صورت پاسخ سرویس، خطای 502 خواهد بود.

  • شناسه سرویس : 1882635

  • پارامتر ورودی سرویس

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

Body

Json

اجباری

پارامتر درخواست

  • مشخصات پارامتر درخواست (Body)

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

Image

string

اجباری

تصویر (به صورت base64_encode )

  • پارامتر های خروجی :

نام پارامتر

نوع

توضیحات

hasError

bool

نشاندهندهی این است که  آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر.

messageId

int

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

شناسهی درخواست در پلتفرم پاد.

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجهی فراخوانی سرویس در این آبجکت نمایش داده میشود که در ادامه شرح داده خواهد شد.

 

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

به صورت دقیقتر، بدنهی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است:

پارامتر های پاسخ سرویس در Result :

json

 

  • مشخصات پارامتر پاسخ

نام پارامتر

نوع

توضیحات

Status

Boolean

کد پاسخ سرویس طبق جدول پاسخ های انتهای مستند

Message

Int

پیام سرویس

Data

String

Image: کد تصویر پلاک پوشیده شده خودرو

  • جدول خروجی ناموفق

نام پارامتر

نوع

توضیحات

Status

Int

کد پاسخ سرویس طبق جدول پاسخ های انتهای مستند

Message

String

پیام خطا

 

کدهای خطای سرویس اصلی

کد خطا

عنوان

توضیحات

0

Success

موفق

101

Access No

اجازه دسترسی ندارید

108

Disabled Totally Service

استعلام فعال نیست

109

User For Disabled Service

استعلام مورد نظر شما فعال نمیباشد

110

Disabled Service

سرویس با اختلال همراه است

137

Package Not Exists

اشتراک یافت نشد

140

Used Credit Package

حجم استعلام به اتمام رسیده است

150

Maximum Transaction Per Second Reached

حداکثر حجم تراکنش در ثانیه است

203

Empty Is NID

شماره ملی وارد نشده است

204

Invalid Is NID

شماره ملی نادرست است

205

Error

خطا

216

Invalid Is Type Service

نوع درخواست بانکی نامعتبر است

231

Empty Is Number Cheque

شماره چک ارسال نشده است

232

Cheque Number is Invalid

شماره چک اشتباه است

233

Information Not Found

اطلاعات یافت نشد

501

Image Is Invalid

تصویر نامعتبر است

502

Image Is Invalid

تصویر نامعتبر است

503

Image Type Is Invalid

نوع تصویر نامعتبر است

504

Service Error

خطای سرویس

505

Service Failed

خطای سرویس

506

Detect Faces Many Too

چندین چهره وجود دارد

507

Found Not Face

چهره یافت نشد

508

Empty Is Video

ویدئو ارسال نشده است

509

Video Is Invalid

ویدئو نامعتبر است

510

3M Than More Is Size Image

اندازه فایل تصویر بیش از 3 مگابایت می باشد

511

15M Than More Is Size Video

اندازه فایل ویدئو بیش از 15 مگابایت می باشد

601

Empty Is Image

تصویر ارسال نشده است

602

Image Is Invalid

تصویر نامعتبر است

603

Image Type Is Invalid

نوع تصویر نامعتبر است

604

3M Than More Is Size Image

اندازه فایل تصویر بیش از 3 مگابایت می باشد

605

Empty Is Height

مقدار قد ارسال نشده است

606

Invalid Is Height

مقدار قد نامعتبر است

607

Service Error

خطا سرویس

608

Service Failed

خطای سرویس

609

Side One In Are Images

تصاویر از یک زاویه می باشند

610

Image Format Is Invalid

فرمت تصویر نامعتبر است

611

Detected Not Data

تصویر قابل پردازش نمیباشد

612

Wrong Is Height

مقدار قد نامعتبر است

701

Empty Is Image

تصویر ارسال نشده است

702

Image Is Invalid

تصویر نامعتبر است

703

Image Type Is Invalid

نوع تصویر نامعتبر است

704

3M Than More Is Size Image

اندازه فایل تصویر بیش از 3 مگابایت می باشد

705

Service Error

خطای سرویس

706

Service Failed

 

707

License Plate Not Found

 

16

No HTTP resource was found 16 (401 Unauthorized)

نکته :در صورت بروز خطا در هر یک از سرویس هایی که از برنامه توکن استفاده میکنند به صورت خودکار پارامتر hasError در پاسخ سرویس اصلی معادل true قرار خواهد گرفت.

در مثال زیر خطای تولید شده توسط توکن در سرویس به این صورت نمایش داده خواهد شد.

json

کد خطا

عنوان خطا

توضیحات

0

عملیات با موفقیت انجام شد

تولید توکن با موفقیت انجام شده است

404

خطا در شبکه

موقتا برنامه در دسترس نمیباشد

500

خطا در دریافت اطلاعات

خطایی در دریافت اطلاعات برنامه رخ داده است

502

خطای داخلی

برنامه دچار خطای داخلی شده است

 

 

Clasor npm package version 2.1.4
به پادیوم قدرت داده اند:
pasargad
fanap
pod