اندپوینت و دسترسی امضای PDF
این صفحه مستندات فنی فراخوانی POST /sign/v2/clients/{clientId}/digitalSign/sign است.
Scope: sign:digital-sign:post
Grant type: client_credentials
دسته‌بندی OpenAPI: امضای دیجیتال. شناسه عملیات: signDigitalSignPost.
معرفی امضای PDF
امضای یک PDF با تصویر امضا. کلاینت multipart می‌فرستد. BoomCore هر فایل را به `{ fileData, name, mimetype, size }` تبدیل می‌کند و JSON به سرویس امضا می‌رود.
ورودی و خروجی امضای PDF
ورودی‌های اصلی: شناسه کلاینت، کد پیگیری، فایلی که BoomCore بعد از multipart به سرویس امضا می‌فرستد، فایلی که BoomCore بعد از multipart به سرویس امضا می‌فرستد، signerNationalId، pin، کد دریافت شده، x، y، width، height.
پارامترهای اختیاری متداول: کد ارائه‌دهنده.
فیلدهای مهم پاسخ: PDF امضاشده، base64، شناسه پیگیری درخواست امضا، providerCode.
جزئیات نوع داده، الزامی بودن و نمونه JSON در مشخصات Elements همین صفحه آمده است.
کاربرد فنی امضای PDF
امضای یک PDF با تصویر امضا. کلاینت multipart می‌فرستد. BoomCore هر فایل را به { fileData, name, mimetype, size } تبدیل می‌کند و JSON به سرویس امضا می‌رود.
پس از دریافت توکن مناسب (مطابق Grant type)، درخواست را به مسیر بالا بفرستید و پاسخ را بر اساس اسکیمای اعلام‌شده پردازش کنید. راهنمای گرفتن توکن در راهنمای شروع آمده است.
در صورت خطای احراز هویت یا Scope ناکافی، ابتدا اعتبار توکن و سطح دسترسی کلاینت را بررسی کنید؛ سپس پارامترهای الزامی مسیر و بدنه را با اسکیمای همین صفحه تطبیق دهید.
برای توضیح کسب‌وکاری، موارد استفاده و پیش‌نیازها به صفحه سرویس «امضای PDF» مراجعه کنید.
عملیات مرتبط با امضای PDF
- ثبت‌نام گواهی امضای دیجیتال —
POST /sign/v2/clients/{clientId}/digitalSign/enroll - ثبت‌نام گواهی امضای دیجیتال —
POST /sign/v2/clients/{clientId}/digitalSign/enroll - درخواست کد یکبارمصرف امضای دیجیتال —
POST /sign/v2/clients/{clientId}/digitalSign/otpRequest - درخواست کد یکبارمصرف امضای دیجیتال —
POST /sign/v2/clients/{clientId}/digitalSign/otpRequest - ابطال گواهی امضای دیجیتال —
POST /sign/v2/clients/{clientId}/digitalSign/revoke