تجاوز إلى المحتوى الرئيسي
مِرقم
ابدأ مجانًا
في هذه الصفحة

المصادقة

يدعم مرقم نوعين أساسيين من المصادقة:

  1. وصول الآلات عبر Authorization: Bearer <مفتاح API> — موصى به للاتصال بين الخوادم.
  2. وصول جلسة المستخدم عبر Authorization: Bearer <Clerk JWT> — تستخدمه لوحة التحكم.

كلاهما يستخدم رأس Authorization القياسي مع Bearer token.

Base URL

text
https://api.mirqam.net

للتطوير المحلي:

text
http://localhost:8000

مصادقة الآلات — مفتاح API

أنشئ مفتاح API من لوحة التحكم. تبدأ المفاتيح بـ ak_....

أرسله كـ Bearer token في كل طلب:

http
Authorization: Bearer ak_live_********

يعمل هذا مع نقاط /v1/* الموجهة للآلات مثل:

  • GET /v1/fonts
  • GET /v1/templates
  • POST /v1/render

مصادقة الجلسة — Clerk JWT

تستخدم لوحة التحكم جلسات Clerk وترسل JWT كـ Bearer token:

http
Authorization: Bearer <CLERK_SESSION_JWT>

مطلوب للوصول إلى:

  • /v1/me و /v1/me/*
  • /v1/admin/* (يتطلب دور admin أيضًا)

معرّفات الطلبات

كل استجابة تتضمن رأس X-Request-Id. تتضمنه الأخطاء أيضًا في حقل request_id.

يمكنك تعيين المعرّف بنفسك لتتبع الطلبات في سجلاتك:

http
X-Request-Id: 6d5f0a03-0b38-4f03-bd6f-4e9f0c0a03a1
المصادقة | Mirqam Docs