API امضای الکترونیکی Certyneo در Postman
مجموعه عمومی Certyneo را در Postman وارد کنید و هر نقطه پایانی API REST v1 را آزمایش کنید — ایجاد پاکتها، ارسال، پیگیری وضعیت، webhookها — با نمونههای درخواست از پیش تکمیلشده.
مجموعه رایگان و عمومی. برای اجرای درخواستها، کلید API Certyneo ضروری است.
چرا از مجموعه Postman Certyneo استفاده کنیم
مجموعه برای توسعهدهندگانی طراحی شده است که میخواهند API Certyneo را بدون خواندن کل مستندات قبل از اجرای درخواست اول خود کاوش کنند.
درخواستهای آماده به کار
هر endpoint از REST API v1 با مثال درخواست و پاسخ مستند شده است و پس از وارد کردن کلید API خود آماده اجرا است.
محیطهای آزمایشی
یک متغیر محیط Postman شامل کلید API و URL پایه شما است تا به راحتی بین حسابها یا محیطهای خود تغییر کنید.
مستندات تولید شده به صورت خودکار
مستندات Postman از مجموعه با مشخصات OpenAPI API Certyneo همزمان باقی میماند — هیچ تفاوتی بین آنچه شما آزمایش میکنید و آنچه در تولید است وجود ندارد.
آزمایش بدون نوشتن کد
یک پاکت ایجاد کنید، آن را ارسال کنید و وضعیت آن را مستقیماً از رابط Postman پیگیری کنید، حتی قبل از یکپارچهسازی API در برنامه خود.
آنچه این مجموعه پوشش میدهد
نمای کلی از گروههای endpoints دسترسپذیر در مجموعه عمومی.
| گروه | آنچه در آن قرار دارد |
|---|---|
| پاکتها | ایجاد، ارسال، فهرست کردن، مشاهده و لغو یک پاکت امضا. |
| اسناد | بارگذاری یک سند یا وارد کردن آن از یک URL (sourceUrl)، مشاهده وضعیت آن. |
| امضاکنندگان | اضافه کردن گیرندگان، تعریف ترتیب و سطح امضای آنها (SES/AES). |
| Webhooks | ایجاد و مدیریت اشتراکهای رویدادهای امضا. |
| ارسال انبوه | ارسال چندین پاکت در یک درخواست واحد برای کمپینهای امضای حجیم. |
مجموعه به صورت عمومی قابل خواندن است: میتوانید آن را بدون حساب کاربری مشاهده کنید، اما اجرای درخواستها نیاز به یک کلید API معتبر Certyneo دارد.
شروع با مجموعه در 4 مرحله
کمتر از 5 دقیقه برای راهاندازی اولین درخواست خود لازم است.
- 1
درونریزی مجموعه عمومی
از Postman، مجموعه عمومی Certyneo را باز کنید و بر روی « Fork » یا « Import » کلیک کنید تا آن را در فضای شخصی خود کپی کنید.
- 2
تولید کلید API Certyneo
در داشبورد Certyneo خود، گزینه تنظیمات → کلیدهای API را باز کنید و یک کلید اختصاصی برای Postman ایجاد کنید.
- 3
پر کردن متغیر محیط
کلید API خود را در متغیر محیط مجموعه Postman قرار دهید، همراه با URL پایه API.
- 4
ارسال اولین درخواست
درخواست « ایجاد پاکت » را راهاندازی کنید و نتیجه را مستقیماً در Postman دنبال کنید.
امنیت و بهترین شیوهها
درخواستهای مجموعه از همان API میگذرند که برنامه شما در تولید استفاده میکند: همان قوانین امنیتی اعمال میشوند.
- تمام درخواستها حداقل از طریق HTTPS/TLS 1.2 منتقل میشوند.
- هر کلید API محدود به مجوزهایی است که هنگام ایجاد آن به آن اعطا میکنید.
- برای تستهای Postman خود یک کلید تست اختصاصی استفاده کنید، جدا از کلید تولید خود.
- یک کلید API که به میان رفته یا استفاده نشده است میتواند با یک کلیک از داشبورد Certyneo خود لغو شود.
سؤالات متداول
آیا برای استفاده از مجموعه Postman به طرح پولی نیاز است؟
خیر. این مجموعه عمومی و رایگان است. محدودیتهای طرح Certyneo شما (تعداد پاکت، ویژگیها) برای درخواستهای اجراشده اعمال میشود، درست مثل هر استفادهای از API.
کلید API خود را کجا بیابم؟
در داشبورد Certyneo شما، در بخش تنظیمات → کلیدهای API. یک کلید اختصاصی برای آزمایشهای Postman خود ایجاد کنید.
آیا این مجموعه با آخرین نسخه API بروز است؟
بله، این مجموعه در هر تغییر API REST v1 از مشخصات OpenAPI رسمی API Certyneo دوباره تولید میشود.
آیا میتوانم webhooks را از Postman آزمایش کنم؟
بله، این مجموعه شامل endpoints برای ایجاد و فهرستکردن اشتراکهای webhook شما است. برای دریافت رویدادها بهصورت محلی، از سرویس تونل HTTP در طول آزمایشهای خود استفاده کنید.
آیا استفاده از مجموعه Postman هزینهای دارد؟
خیر، تنها مصرف خود API (ایجاد پاکتها) از طرح شما کسر میشود، دقیقاً مانند یک فراخوانی API معمولی.
برای اطلاعات بیشتر
API Certyneo را در Postman آزمایش کنید
مجموعه عمومی، رایگان، همزمانشده با اسناد توسعهدهندگان ما.