API توسعه‌دهندگان REST · OpenAPI 3.0
ادغام قرارداد، فرم، امضای الکترونیک و استعلام هویت (شاهکار + شخص حقوقی) با سیستم خودتان — از طریق REST API استاندارد با Bearer token و مستندات تعاملی OpenAPI 3.0.
Endpoints موجود
۴۵ endpoint در ۷ گروه — هر کدام با CRUD کامل + actionها.
Contracts
ساخت، آپلود فایل، افزودن امضاکننده، resend SMS، دانلود PDF نهایی.
Forms
لیست فرم‌های شما، فرم تک، schema، submissionها.
استعلام هویت
اعتبارسنجی زندهٔ شاهکار و شخص حقوقی روی فیلدهای یک فرم، پیش از ثبت پاسخ.
Templates
فهرست قالب‌های سازمانی شما، جزئیات قالب و پیش‌نمایش هر صفحه.
Webhooks
اشتراک رویدادها، رویداد آزمایشی، تاریخچهٔ تحویل و ارسال مجدد.
گواهی دیجیتال
شروع صدور برای یک شخص، تعیین پرداخت‌کننده، فهرست و وضعیت گواهی‌ها.
حساب و هزینه
اطلاعات توکن، سهمیهٔ باقی‌مانده، برآورد هزینه پیش از ساخت سند، و سلامت سرویس.
احراز هویت
با Laravel Sanctum Bearer token. هر API key یک کاربر را تشخیص می‌دهد، scope محدود می‌شود و در پنل قابل revoke است.
Rate limits
منصفانه و قابل بسط. تعدیل بر اساس پلن کاربر.
سهمیهٔ امضا مشترک است بین پنل و API — دو سهمیهٔ جدا نیست. پس از اتمام سهمیه، مصرف از کیف پول ادامه پیدا می‌کند و درخواست رد نمی‌شود.
برای چه چیزی استفاده می‌شود؟
CRM ادغام
CRM شما هر بار که قرارداد جدید نیاز است، با یک API call آن را در ال‌امضا ایجاد می‌کند.
سیستم HR
سیستم منابع انسانی، فرآیند استخدام جدید را با امضای الکترونیک آماده‌ی شاهکار می‌کند.
پنل بانکی
بانک یا فین‌تک، فرآیند استعلام شاهکار + امضای قرارداد را به پنل خود متصل می‌کند.
پلتفرم املاک
سامانه‌ی املاک، قرارداد اجاره را خودکار با اطلاعات موجر/مستأجر می‌سازد و امضا می‌فرستد.
فروشگاه‌های آنلاین
فروشگاهی که فروش با امضا را می‌خواهد (مثلاً فروش وسایل سنگین) از API برای ثبت امضا استفاده می‌کند.
اتوماسیون اداری
سیستم BPM شرکت، گردش امضا اسناد را با ال‌امضا تکمیل می‌کند.
سؤالات رایج توسعه‌دهندگان
بعد از ثبت‌نام در ال‌امضا، در پنل کاربری به بخش «API» بروید و یک token بسازید. به‌صورت پیش‌فرض scope برای contracts + forms + KYC فعال است. در همان صفحه می‌توانید token را revoke یا regenerate کنید.
مستندات تعاملی در /docs قرار دارد — تولید شده با Scribe. برای هر endpoint مثال cURL، Postman و JavaScript آماده دارد. می‌توانید همان‌جا با token خودتان آن را تست کنید.
بله. ۲۱ رویداد قابل اشتراک است و می‌توانید اشتراک را از خودِ API بسازید، ویرایش یا حذف کنید. رویداد آزمایشی بفرستید، تاریخچهٔ تحویل‌ها را ببینید و هر تحویل ناموفق را دوباره ارسال کنید. هر درخواست با هدر امضای HMAC و مهر زمان می‌آید تا بتوانید اصالتش را بررسی کنید.
بر اساس پلن user. هر API call که از سقف بگذرد، response 429 با header Retry-After می‌گیرد. می‌توانید با ارتقای پلن سقف را بالا ببرید.
بله. SDK رسمی PHP با نام «elemza/elemza-php-sdk» منتشر شده و افزونهٔ رسمی وردپرس هم موجود است. علاوه بر آن‌ها، مشخصات OpenAPI 3.0 در /docs/openapi قرار دارد و با ابزارهایی مثل openapi-generator می‌توانید برای زبان‌های دیگر هم کلاینت بسازید.
شروع به یکپارچه‌سازی
رایگان ثبت‌نام کنید و یک API token بسازید — همان لحظه به /docs دسترسی دارید.