API مدرکم

توسعه‌دهندگان

صدور مدرک را با API مدرکم به سیستم‌های خود متصل کنید.

شروع سریع

سازمان خود را در مدرکم ثبت کنید.

یک توکن API در تنظیمات سازمان ایجاد کنید.

سطوح دسترسی مورد نیاز را به توکن اختصاص دهید.

اولین درخواست API خود را برای صدور مدرک ارسال کنید.

نمونه درخواست

curl -X POST https://api.madrakam.com/back/certificate/create \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationCertificateId": "TEMPLATE_ID",
    "recipientEmail": "user@example.com",
    "recipientName": "علی محمدی"
  }'

احراز هویت

توکن‌های API مختص سازمان هستند — هر توکن به یک سازمان تعلق دارد.

توکن‌ها توسط مالکان یا مدیران در پنل تنظیمات سازمان ایجاد می‌شوند.

مقدار توکن فقط یک‌بار هنگام ایجاد نمایش داده می‌شود (پس از آن هش یک‌طرفه می‌شود).

توکن از طریق هدر درخواست برای احراز هویت ارسال می‌شود.

توکن‌ها در هر زمان قابل غیرفعال‌سازی یا حذف هستند.

هدر درخواست:Authorization: Bearer YOUR_API_TOKEN

سطوح دسترسی توکن API

دسترسی با حداقل سطح مورد نیاز (Least Privilege):

صدور مدرکISSUE_CERTIFICATE

صدور مدارک جدید با قالب‌های موجود

ابطال مدرکREVOKE_CERTIFICATE

ابطال مدارک فعال

مشاهده مدرکVIEW_CERTIFICATE

خواندن جزئیات و وضعیت مدارک

چندین سطح دسترسی را می‌توان به یک توکن اختصاص داد. برای هر اتصال یک توکن اختصاصی بسازید (مثلاً یکی برای LMS جهت صدور، دیگری برای داشبورد جهت خواندن).

نمای کلی Endpointها

مدیریت مدارک

صدور، مشاهده، ابطال و لیست مدارک

دسترسی به قالب‌ها

خواندن قالب‌های مدرک موجود

استعلام

تأیید اصالت مدرک با کد هش (بدون احراز هویت)

مستندات کامل API

الگوهای یکپارچه‌سازی

اتصال به سامانه آموزشی

صدور خودکار مدرک پس از اتمام دوره

ISSUE_CERTIFICATE

سیستم منابع انسانی

صدور گواهی انطباق پس از تکمیل آموزش

ISSUE_CERTIFICATE

CRM / پورتال شریک

صدور مدرک برای شرکای خارجی

ISSUE_CERTIFICATE, VIEW_CERTIFICATE

خط لوله CI/CD

خودکارسازی صدور گواهینامه در گردش کار استقرار

ISSUE_CERTIFICATE, REVOKE_CERTIFICATE

SDK و ابزارها

در حال حاضر: REST API با پاسخ‌های JSON

مشخصات Swagger/OpenAPI برای تولید خودکار کلاینت در دسترس است.

SDKهای اختصاصی در نسخه‌های آینده اضافه خواهند شد.

محدودیت نرخ و بهترین شیوه‌ها

بهترین شیوه‌ها:

برای هر اتصال یک توکن اختصاصی استفاده کنید.

حداقل سطوح دسترسی مورد نیاز را اختصاص دهید.

توکن‌ها را به‌صورت دوره‌ای تعویض کنید.

صدور مدارک را از طریق داشبورد سازمان نظارت کنید.

اطلاعات محدودیت نرخ بر اساس پلن سازمان متفاوت است.

آماده شروع هستید؟

ثبت‌نام سازمان تماس با تیم فنی