مقدمه 

از این سرویس جهت تطبیق چهره دو تصویر و ویدئو و همچنین استخراج و استعلام اطلاعات تصاویر کارت ملی ، کارت خودرو ، گواهینامه استفاده میشود.

به صورتی که با ارسال کد تصویر یا ویدئو در ورودی هر سرویس وضعیت استعلامی آن در خروجی نمایش داده میشود.

پیش از شروع

  • URL فراخوانی سرویس­ها:

Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall

Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall

  • تمامی درخواست­ها با متد POST ارسال می­شوند.
  • فیلدهای زیر درHeader تمامی درخواست­ها ثابت است:

پارامتر

توضیحات

_token_

توکن کسب­وکاری دریافتی از پنل

_token_issuer_

مقدار ثابت "1"

  • فیلدهای زیر در بدنه‌ی تمامی درخواست‌ها ثابت است (با فرمت x-www-form-urlencoded):

پارامتر

توضیحات

scProductId

شناسه­‌ی سرویس مدنظر

scApiKey

راهنمای دریافت این پارامتر در این لینک موجود است.

  • علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
  • خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

نکته: پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی می‌کنند.

در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

سرویس های احراز هویت - تطبیق چهره

از این سرویس جهت مقایسه و تطبیق دو چهره استفاده میشود به صورتی که در ورودی کد encode_base64 تصویر ها جهت بررسی دریافت و در خروجی میزان شباهت تصاویر را مشخص می کند.

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

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

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

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

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

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

نام پارامتر

نوع

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

توضیحات

Image1

String

اجباری

کد encode_base64  تصویر اول

Image2

String

اجباری

کد encode_base64  تصویر دوم

 

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

به صورت کلی پاسخ خروجی result  صورتی زیر میباشد.

json

 

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

نام پارامتر

نوع

توضیحات

Status

String

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

Message

String

پیام سرویس

Data

String

IsSame : تطبیق چهره (1: تطبیق و 0 عدم تطبیق)

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

نام پارامتر

نوع

توضیحات

Status

Int

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

Message

String

پیام خطا

سرویس های احراز هویت - اعتبارسنجی ویدئو

از این سرویس جهت مقایسه و تطبیق کد فایل ویدئو و تصویر چهره فرد استفاده می شود به صورتی که اگر در فایل ویدئویی شامل تصویر باشد تشخیص سرویس انجام خواهد شد.

همچنین این سرویس می تواند متن ارسالی را جهت تطبیق در فایل ویدئویی استفاده نماید.

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

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

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

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

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

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

نام پارامتر

نوع

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

توضیحات

Image

string

اجباری

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

Video

string

اجباری

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

Speech

string

اختیاری

متن

 

 

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

 

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

نام پارامتر

نوع

توضیحات

Status

String

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

Message

String

پیام سرویس

Data

json

IsSame: تطبیق چهره 1 : تطبیق و 0: عدم تطبیق

Speech: متن ویدئو 

SpeechSimilarity : درصد تشابه متن ارسالی و متن ویدئو 

 

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

نام پارامتر

نوع

توضیحات

Status

Int

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

Message

String

پیام خطا

 

سرویس های احراز هویت – دریافت اطلاعات تصویر کارت ملی و مقایسه با ثبت احوال

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

همچنین این سرویس اطلاعات استعلام شده از کارت ملی را با ثبت احوال مقایسه و میزان اعتبارسنجی آن را در پاسخ مشخص میکند.

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

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

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

نام پارامتر

نوع

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

توضیحات

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: شماره ملی

BirthDate: تاریخ تولد

ExpireDate: پایان اعتبار

FirstName: نام

LastName: نام خانوادگی

FatherName: نام پدر

Gender: (مرد: male و زن: famle و درغیراینصورت: unknow)

HasSimilarity: دارای تشابه (0و1)

Similarity: تشابه

FirstNameSimilarity: درصد تشابه نام

LastNameSimilarity: درصد تشابه نام خانوادگی

FatherNameSimilarity: درصدتشابه نام پدر

 

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

نام پارامتر

نوع

توضیحات

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