جميع الأدلة

الفريق والإدارة

رموز API

دع البرامج والنصوص البرمجية وعمليات الأتمتة تدير Sealed Print باستخدام رمز API.

يمنح رمز API برنامجًا ما الوصول إلى REST API الخاصة بـ Sealed Print، مثلًا لمتابعة المهام أو إدارة الوجهات أو قراءة قائمة الانتظار من نص برمجي. يعمل الرمز نيابةً عن الشخص الذي أنشأه، بصلاحيات لا تتجاوز صلاحياته، وفي المؤسسة التي أُنشئ فيها فقط. يصف مرجع API كل نقطة نهاية مع أمثلة.

المتطلبات المسبقة

  • يمكن لكل عضو إنشاء الرموز في جلسة متصفح. يرى المسؤولون جميع رموز المؤسسة ويمكنهم إبطالها.
  • تدير الرموز Sealed Print وتتحكم فيه: المهام والمصادر والوجهات والإعدادات. لكنها لا تستطيع إرسال مهام؛ بل ترسل البرامج المستندات إلى نقطة نهاية API بدلًا من ذلك.
  • مضمّنة في كل خطة.

الإعداد لمرة واحدة

  1. انتقل إلى الإعدادات ← رموز API واختر رمز جديد.
  2. أدخل الاسم الذي يوضح الغرض من الرمز، مثلًا «تصدير فواتير المحاسبة».
  3. اختر الصلاحيات: المستخدم (مصادرك ووجهاتك ومهامك الخاصة) أو المسؤول أو المالك، بحد أقصى دورك أنت.
  4. اختر انتهاء الصلاحية: 7 أو 30 أو 90 يومًا، أو سنة واحدة، أو تاريخ مخصص، أو بلا انتهاء صلاحية.
  5. اختر إنشاء وانسخ الرمز. يُعرض الآن فقط؛ احفظه بشكل آمن، مثلًا في مدير كلمات المرور.

أرسل الرمز مع كل طلب في الترويسة Authorization: Bearer sp_api_…. لعرض مهامك:

curl "https://www.sealedprint.com/api/jobs" \
  -H "Authorization: Bearer sp_api_…"

وبالترويسة نفسها يتابع برنامجك مهمة (GET /api/jobs/{id})، أو يرسلها إلى وجهات أخرى أو يلغيها.

في كل مرة

  • يُظهر آخر استخدام في قائمة الرموز ما إذا كان أحد البرامج لا يزال يستخدم الرمز.
  • يغيّر إعادة تسمية الاسم؛ ويُصدر تدوير سرًا جديدًا للرمز نفسه (يتوقف السر القديم عن العمل فورًا، ويبقى الاسم والصلاحيات وتاريخ الانتهاء كما هي)؛ وينهيه إبطال نهائيًا.
  • يعرض «عرض المنتهية والمُبطلة» الرموز التي لم تعد تعمل.

استكشاف الأخطاء وإصلاحها

  • HTTP 401: الرمز مفقود أو خاطئ أو منتهي الصلاحية أو مُبطل.
  • HTTP 403: لا تسمح صلاحيات الرمز بهذا الإجراء. لا يمكن إرسال مهمة باستخدام رمز (الرمز api_endpoint_required)؛ أرسل المستند إلى نقطة نهاية API.
  • توقف رمز عن العمل فجأة: تصبح الرموز غير صالحة عندما يغادر الشخص الذي أنشأها المؤسسة. أنشئ رمزًا جديدًا بواسطة عضو آخر.
  • نُسخ الرمز إلى مكان لا ينبغي أن يكون فيه: اختر تدوير أو إبطال فورًا.

الخطوات التالية