مفاتيح API
مفتاح لكل مهمة، ولا شيء أكثر.
امنح كل خدمة مفتاحها الخاص، بالصلاحيات والمرسلين الذين تحتاجهم فقط. كل استدعاء تجريه يُسجَّل.
باختصار
ما هو مفتاح API؟
سرّ يرسله كودك مع كل طلب. يحدّد لأي مساحة عمل هذا الاستدعاء وما المسموح له فعله.
32
صلاحية للاختيار منها
25
نطاقاً كاملاً في نطاق إرسال واحد
3,650
يوماً، أطول مدة صلاحية
كيف يعمل
دور كسقف
اربط دوراً فلن يتمكن المفتاح أبداً من فعل أكثر مما يسمح به. يُظهر GET /ping ما يطلبه المفتاح وما تركه له الدور.
حدّد باسم من يرسل
حتى 25 نطاقاً كاملاً و50 عنواناً منفرداً. المرسل من خارجها يتلقى 403.
كل استدعاء مسجّل
الطريقة والمسار والحالة والخطأ والمدة لكل طلب، مع أكثر المسارات استخداماً وعدد مرات فشلها.
تحقّق مما يستطيعه المفتاح
لا يحتاج GET /ping أي صلاحية، ويجيب بمدى وصول المفتاح.
{ "ok": true, "keyId": "4c1b257a66287fd113bd89d0", "mode": "live", "scopes": ["emails:send", "templates:write", "members:write"], "roleId": "role_2b81de079c1f0a4b7e05d386", "grantedScopes": ["emails:send", "templates:write"], "workspaceId": "10417196-e324-4283-af98-66ec62167c47"}ما الذي تحصل عليه
في المنتج اليوم
تدوير في مكانه
سرّ جديد بالمعرّف والصلاحيات والسجل نفسها.
مُبطَل لا محذوف
يُقال لأي استدعاء لاحق revoked_api_key.
انتهاء صلاحية مدمج
اجعل المفتاح ينتهي، حتى عشر سنوات مقدماً.
ممارسات جيدة
لتستفيد منه إلى أقصى حد
- 01
مفتاح لكل خدمة
فيكلّف التسريب تكاملاً واحداً لا كل التكاملات.
- 02
امنح الحدّ الأدنى
ابدأ بـ emails:send وأضف الصلاحيات حين يحتاجها استدعاء.
- 03
راقب الإخفاقات
صفِّ سجل الطلبات على الاستدعاءات الفاشلة بعد كل نشر.
أين وصلنا
من المفيد معرفته
- لا قائمة IP مسموحة
- لا يمكن بعدُ ربط المفتاح بعناوين خوادمك.
- لا مفاتيح اختبار
- لا يمكن إنشاء سوى مفاتيح oe_live_، لذا كل إرسال حقيقي.
- لا سجل عبر الـ API
- يُقرأ سجل الطلبات في التطبيق، لا عبر مسار REST.
أسئلة
ما يُسأل عنه كثيرًا
تابع القراءة
يعمل جيدًا مع
ابدأ
نطاقك،
بريدك.
وجّه نطاقًا إلى OpenEmail واقرأ بريده في صندوق بريد مبنيّ حوله. الخطة المجانية تشمل نطاقًا واحدًا.
