خانه خدمات تعرفه‌ها وبلاگ سؤالات متداول تماس با ما
ورود ثبت‌نام رایگان
سرویس فعال · /api/v1

API توسعه‌دهندگان REST · OpenAPI 3.0

ادغام قرارداد، فرم، امضای الکترونیک و استعلام هویت (شاهکار + شخص حقوقی) با سیستم خودتان — از طریق REST API استاندارد با Bearer token و مستندات تعاملی OpenAPI 3.0.

مستندات کامل API دریافت API key
REST + JSON Bearer token + Sanctum Scribe docs (Postman + cURL)

Endpoints موجود

۴ resource اصلی — هر کدام با CRUD کامل + actionها.

Contracts

ساخت، آپلود فایل، افزودن امضاکننده، resend SMS، دانلود PDF نهایی.

POST /contracts
GET /contracts/{code}
POST /contracts/{code}/signers
GET /contracts/{code}/pdf

Forms

لیست فرم‌های شما، فرم تک، schema، submission‌ها.

GET /forms
GET /forms/{slug}
GET /forms/{slug}/submissions

KYC

استعلام شاهکار، شخص حقوقی، اعتبارسنجی کد ملی.

POST /kyc/shahkar
POST /kyc/legal-entity
POST /kyc/identity

Cost Estimate

محاسبه‌ی هزینه‌ی یک عملیات قبل از انجام — برای پیش‌نمایش به کاربر.

GET /cost-estimate?service=signature
مشاهده‌ی همه‌ی endpoints در /docs

احراز هویت

با Laravel Sanctum Bearer token. هر API key یک کاربر را تشخیص می‌دهد، scope محدود می‌شود و در پنل قابل revoke است.

# Example request
curl -X POST api.elemza.com/v1/contracts \
-H "Authorization: Bearer YOUR_TOKEN"
-H "Content-Type: application/json"
-d '{"title": "..."}'

Rate limits

منصفانه و قابل بسط. تعدیل بر اساس پلن کاربر.

Free
۶۰ req / دقیقه · ۳ امضا / ماه
Bronze
۱۲۰ req / دقیقه · ۳۰ امضا / ماه
Silver
۳۰۰ req / دقیقه · ۱۰۰ امضا / ماه
Gold
۱۰۰۰ req / دقیقه · ۲۰۰ امضا / ماه

برای چه چیزی استفاده می‌شود؟

CRM ادغام

CRM شما هر بار که قرارداد جدید نیاز است، با یک API call آن را در ال‌امضا ایجاد می‌کند.

سیستم HR

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

پنل بانکی

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

پلتفرم املاک

سامانه‌ی املاک، قرارداد اجاره را خودکار با اطلاعات موجر/مستأجر می‌سازد و امضا می‌فرستد.

فروشگاه‌های آنلاین

فروشگاهی که فروش با امضا را می‌خواهد (مثلاً فروش وسایل سنگین) از API برای ثبت امضا استفاده می‌کند.

اتوماسیون اداری

سیستم BPM شرکت، گردش امضا اسناد را با ال‌امضا تکمیل می‌کند.

سؤالات رایج توسعه‌دهندگان

بعد از ثبت‌نام در ال‌امضا، در پنل کاربری به بخش «API» بروید و یک token بسازید. به‌صورت پیش‌فرض scope برای contracts + forms + KYC فعال است. در همان صفحه می‌توانید token را revoke یا regenerate کنید.

مستندات تعاملی در /docs قرار دارد — تولید شده با Scribe. برای هر endpoint مثال cURL، Postman و JavaScript آماده دارد. می‌توانید همان‌جا با token خودتان آن را تست کنید.

فعلاً نه. در نقشه‌ی راه برای Phase 8 است (وقتی بیش از ۱۰ مشتری API فعال داشته باشیم). برای حالا، می‌توانید endpoint های GET را poll کنید.

بر اساس پلن user. هر API call که از سقف بگذرد، response 429 با header Retry-After می‌گیرد. می‌توانید با ارتقای پلن سقف را بالا ببرید.

فعلاً نه — ولی OpenAPI 3.0 spec در /docs/openapi قرار دارد. با ابزارهایی مثل openapi-generator می‌توانید SDK خودکار برای ۲۰+ زبان برنامه‌نویسی بسازید.

شروع به یکپارچه‌سازی

رایگان ثبت‌نام کنید و یک API token بسازید — همان لحظه به /docs دسترسی دارید.

/docs (مستندات کامل) دریافت API key

پشتیبان هوشمند

آنلاین و آماده پاسخگویی

برای شروع گفتگو، شماره موبایل یا ایمیل خود را وارد کنید.

پشتیبان هوشمند

دستیار هوش مصنوعی