تخطَّ إلى المحتوى
TurnitPass
المطوّرونAPI v1الحصول على مفتاح API
تصفح التوثيق

المطوّرونالمصادقة

المصادقة باستخدام مفاتيح API

تستخدم طلبات التطوير مفاتيح API التي يتم إنشاؤها من لوحة تحكم TurnitPass.

REST API v1

Auth console

أبقِ مفاتيح API خارج المتصفح.

تستخدم استدعاءات TurnitPass API مفتاح Bearer تابعًا لمساحة العمل. مكان المفتاح هو الشفرة المخصصة للخادم فقط، بينما تبقى لوحة التحكم المكان لإنشاء المفاتيح وتدويرها وإلغائها وفحص الاستخدام.

حواجز المفتاح

كيف تبقي الوصول آمنًا

الخادم فقط

أرسل المفاتيح من مسارات الخلفية أو العمال أو المهام أو server action الآمنة.

يُعرض مرة واحدة

انسخ المفتاح المُنشأ فورًا واحفظه في مدير الأسرار.

تدوير آمن

انشر مفتاح الاستبدال قبل إلغاء مفتاح الإنتاج القديم.

نطاق الحساب

يُجمَّع الاستخدام في رصيد كلمات مساحة العمل وضوابط الفوترة.

طلب Bearer

عقد الترويسة

خاص افتراضيًا
request
Bearer
fetch('https://turnitpass.com/api/v1/humanize', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer tp_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ text: draft, language: 'en' })
})
فشل المصادقة
failed auth
401
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}
01الإنشاء في مساحة العمل
02الحفظ في الأسرار
03الاستدعاء من الخادم
04التدوير أو الإلغاء

مفاتيح API

أرسل مفتاح API مع كل طلب. تظهر المفاتيح مرة واحدة فقط عند الإنشاء ويمكن إلغاؤها من مساحة العمل.

Authorization header
Bearer
Authorization: Bearer tp_live_your_api_key
Content-Type: application/json

POST /api/v1/humanize
تُعرض المفاتيح مرة واحدة عند الإنشاء ويمكن إلغاؤها من مساحة العمل دون تغيير حساب Google.

Managing keys

01

إنشاء

أنشئ مفتاحًا مسمّى من مساحة العمل وانسخه فورًا.

02

إلغاء

عطّل مفتاحًا فورًا. لا يمكن استخدام المفاتيح الملغاة في طلبات جديدة.

03

حدود المعدل

يمكن تقييد كل مفتاح على حدة بينما يُجمَّع الاستخدام في الحساب.

04

الفوترة

تشارك جميع المفاتيح رصيد كلمات الحساب وحدود الاشتراك.

ملك مساحة العمل

Key lifecycle

1

إنشاء مفتاح مسمّى

استخدم اسمًا يصف البيئة أو السطح، مثل Production backend أو Staging worker أو Internal QA.

2

انسخه مرة واحدة إلى مخزن أسرار

يعرض TurnitPass المفتاح عند الإنشاء فقط. احفظه في مزود النشر أو مدير أسرار CI أو ملف .env المحلي.

3

راقب الاستخدام عبر status والفوترة

تشارك جميع المفاتيح رصيد الكلمات، بينما تسهّل أسماء المفاتيح معرفة أي دمج نشط.

4

دُر قبل الإلغاء

أنشئ مفتاح استبدال وانشره وتأكد من سلامة الحركة ثم ألغِ المفتاح القديم من مساحة العمل.

Environment setup

احفظ مفاتيح TurnitPass كأسرار للخادم فقط. تستخدم الأمثلة أدناه أسماء عامة لتناسب Next.js وWorkers ومهام الخادم أو أي بيئة خلفية.

.env
server only
TURNITPASS_API_KEY=tp_live_your_api_key
TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1
التطوير المحلي
.env.local أو مدير أسرار محلياستخدم مفتاحًا غير إنتاجي بميزانية كلمات صغيرة واسم واضح.
نشر المعاينة
مفتاح stagingافصل حركة المعاينة حتى لا تستهلك مهام الاختبار استخدام الإنتاج دون قصد.
الإنتاج
سر للخلفية فقطاقرأ المفتاح فقط من شفرة خادم موثوقة. لا تمرّره إلى المتصفح أبدًا.

Security best practices

من الخادم فقط
لا تعرض المفاتيح في شفرة المتصفحاستخدم المفاتيح من خدمات الخلفية أو المهام أو مسارات الخادم الآمنة.
متغيرات البيئة
استخدم TURNITPASS_API_KEYتجنب تضمين المفاتيح المباشرة في التحكم بالمصدر أو حزم العميل.
تدوير المفاتيح
أنشئ بديلًا قبل الإلغاءاستخدم مفاتيح منفصلة للإنتاج والتجربة والتطوير.
الاستجابة للتسريب
ألغِ فورًاأنشئ مفتاحًا جديدًا من مساحة العمل إذا تسرب مفتاح.

Authentication errors

ترويسة مفقودة
لم يُقدَّم ترويسة Authorization
تنسيق خاطئ
الترويسة لا تبدأ بـ Bearer
مفتاح غير صالح
المفتاح غير موجود أو ملغى أو مشوّه
إخفاقات كثيرة
قد تُقيَّد محاولات المصادقة الفاشلة المتكررة
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

Next steps

بعد ذلك، اربطه بسير عملك.متابعة القراءة