صدور آسان، اعتبار ماندگار
API مدرکم

مدرک را از سیستم خودتان صادر کنید

صدور و استعلام گواهینامه را با چند درخواست ساده به گردش کار خود متصل کنید.

به‌زودی — این مستندات، پیش‌نمایش API در حال آماده‌سازی است
REST با پاسخ JSONتوکن اختصاصی سازمانapi.madrakam.ir
POST/back/certificate/create
پیش‌نمایش
# صدور یک گواهینامه
Authorization: Bearer ••••••

{
  "organizationCertificateId": "TEMPLATE_ID",
  "recipientName": "علی محمدی"
}
شروع سریع

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

چهار قدم تا اتصال صدور مدرک به سیستم شما.

  1. ۰۱

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

  2. ۰۲

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

  3. ۰۳

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

  4. ۰۴

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

POST/back/certificate/createنمونه درخواست
پیش‌نمایش
curl -X POST https://api.madrakam.ir/back/certificate/create \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationCertificateId": "TEMPLATE_ID",
    "recipientEmail": "user@example.com",
    "recipientName": "علی محمدی"
  }'
احراز هویت

یک توکن، مختص سازمان شما

با یک توکن Bearer درخواست‌ها را امضا کنید — بدون گذرواژه، بدون نشست.

  • هر توکن به یک سازمان تعلق دارد و فقط با آن کار می‌کند.

  • مالک یا مدیر سازمان، توکن را در تنظیمات می‌سازد.

  • مقدار توکن فقط یک‌بار نمایش داده می‌شود؛ بعد از آن قابل بازیابی نیست.

  • با هدر Authorization ارسال می‌شود و هر زمان قابل ابطال است.

توکن ساخته شد

فقط یک‌بار
mk_live_••••••••••••4A2Kکپی کنید و امن نگه دارید
Authorizationهدر درخواست
پیش‌نمایش
Authorization: Bearer YOUR_API_TOKEN
سطوح دسترسی

فقط همان اندازه که لازم است

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

صدور مدرک

ISSUE_CERTIFICATE

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

ابطال مدرک

REVOKE_CERTIFICATE

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

مشاهده مدرک

VIEW_CERTIFICATE

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

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

Endpointها

مدرک، قالب و استعلام

صدور و مدیریت با توکن؛ استعلام اصالت، عمومی و بدون احراز هویت.

api.madrakam.irپیش‌نمایش
POST/back/certificate/createتوکن
GET/back/certificate/listتوکن
POST/back/certificate/revokeتوکن
GET/back/organization-certificate/listتوکن
GET/back/certificate/estelam/{code}معتبر

مستندات کامل و مرجع پارامترها — به‌زودی.

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

سیستم شما مدرک را صادر می‌کند

یک درخواست از سامانه‌تان به API مدرکم، و مدرک برای دانش‌پذیر صادر می‌شود.

سامانه شما
API مدرکم
مدرک صادر شد

  • سامانه آموزشی

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

  • منابع انسانی

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

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

    صدور و مشاهده مدرک برای شرکا

  • خط لوله CI/CD

    صدور و ابطال در گردش کار استقرار

SDK و ابزارها

از REST تا کلاینت آماده

REST در نسخه اول؛ OpenAPI و SDKهای رسمی در نسخه‌های بعد.

  • REST + JSON

    رابط REST با پاسخ‌های JSON استاندارد.

    پیش‌نمایش

  • مشخصات OpenAPI

    برای تولید خودکار کلاینت از روی مشخصات.

    به‌زودی

  • SDKهای رسمی

    کتابخانه‌های اختصاصی در نسخه‌های بعدی.

    به‌زودی
بهترین شیوه‌ها

اتصالی امن و قابل‌کنترل

چند عادت ساده که هر یکپارچه‌سازی را امن نگه می‌دارد.

یک توکن برای هر اتصال

هر یکپارچه‌سازی، توکن جدا

حداقل دسترسی لازم

فقط سطوحی که واقعاً نیاز است

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

توکن‌های قدیمی را باطل کنید

نظارت از داشبورد

صدور مدارک را زیر نظر بگیرید

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

آماده اتصال هستید؟

سازمان خود را همراه کنید تا هنگام انتشار API در جریان باشید.

سازمان‌ها

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

درخواست همکاری

سؤال فنی

درباره اتصال، سطوح دسترسی یا زمان انتشار بپرسید.

تماس با تیم فنی