المصادقة
تحتاج كل الطلبات، باستثناء الكتالوج العام، إلى مفتاح لواجهة البرمجة يُرسَل كرمز bearer.
إرسال المفتاح
ضع المفتاح في الترويسة Authorization في كل طلب. تبدأ المفاتيح بـ inker_live_.
Authorization: Bearer inker_live_…curl https://api.inker.si/v1/account \
-H "Authorization: Bearer $INKER_API_KEY"إنشاء مفتاح
أنشئ المفاتيح من صفحة حسابك، في قسم المطوّرين. يظهر المفتاح كاملًا مرة واحدة فقط بعد إنشائه مباشرة، فانسخه حينها: لا يحتفظ inker إلا ببصمة له ولا يمكنه عرضه مرة أخرى أبدًا.
الصلاحيات
لا يستطيع المفتاح استدعاء إلا نقاط النهاية التي تسمح بها صلاحياته؛ وأي نقطة أخرى تجيب بـ insufficient_scope. امنح كل مفتاح ما يحتاج إليه فقط.
| الصلاحية | تسمح بـ |
|---|---|
generate | تسعير عمليات التوليد وبدؤها وإلغاؤها. تنفق العملات. |
read | عرض عمليات التوليد والملفات وقراءتها. |
uploads | رفع ملفات الإدخال. |
account | الاطلاع على رصيدك وحدودك. |
حماية المفاتيح
- استدعِ واجهة البرمجة من خادمك. لا تضع مفتاحًا أبدًا في صفحة ويب أو تطبيق جوال أو مستودع عام.
- حدّد سقفًا شهريًا للعملات لكل مفتاح. بمجرد أن ينفق المفتاح هذا العدد من العملات في شهر ميلادي (بتوقيت UTC)، تجيب عمليات التوليد الجديدة بـ
spend_cap_exceededحتى الشهر التالي. - امنح المفاتيح تاريخ انتهاء (30 أو 90 أو 365 يومًا). يجيب المفتاح المنتهي بـ
api_key_expired. - ألغِ أي مفتاح لم تعد تستخدمه أو ربما تسرّب. يتوقف عن العمل فورًا ويجيب بـ
api_key_revoked.
لا تُدار المفاتيح وخطافات الويب إلا من صفحة حسابك بعد تسجيل الدخول: لا يستطيع مفتاح واجهة البرمجة أبدًا إنشاء مفاتيح أو قراءة الأسرار.