सामग्री पर जाएँ
TurnitPass
डेवलपरAPI v1API कुंजी बनाएँ
दस्तावेज़ देखें

डेवलपरप्रमाणीकरण

API कुंजी से प्रमाणित करें

डेवलपर अनुरोध TurnitPass कार्यस्थान से बनी API कुंजियों का उपयोग करते हैं।

REST API v1

Auth console

API कुंजियाँ ब्राउज़र से बाहर रखें।

TurnitPass API कॉल कार्यस्थान की Bearer कुंजी उपयोग करती हैं। कुंजी केवल सर्वर कोड में रहती है; बनाना, घुमाना, निरस्त करना और उपयोग जाँचना डैशबोर्ड पर रहता है।

कुंजी गार्डरेल

पहुँच सुरक्षित कैसे रखें

केवल सर्वर

कुंजियाँ बैकएंड रूट, worker, जॉब या सुरक्षित 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' })
})
auth विफल
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 या स्थानीय सीक्रेट मैनेजरछोटे शब्द बजट और स्पष्ट नाम वाली गैर-प्रोडक्शन कुंजी उपयोग करें।
प्रीव्यू परिनियोजन
स्टेजिंग कुंजीप्रीव्यू ट्रैफ़िक अलग रखें ताकि परीक्षण जॉब अनजाने में प्रोडक्शन उपयोग न खर्च करें।
प्रोडक्शन
केवल-बैकएंड सीक्रेटकुंजी केवल विश्वसनीय सर्वर कोड से पढ़ें। इसे ब्राउज़र को कभी न दें।

Security best practices

केवल सर्वर-साइड
ब्राउज़र कोड में कुंजियाँ कभी न दिखाएँकुंजियाँ बैकएंड सेवाओं, जॉब या सुरक्षित सर्वर रूट से उपयोग करें।
पर्यावरण चर
TURNITPASS_API_KEY उपयोग करेंलाइव कुंजियाँ स्रोत नियंत्रण या क्लाइंट बंडल में न लिखें।
कुंजियाँ घुमाएँ
निरस्त करने से पहले प्रतिस्थापन बनाएँप्रोडक्शन, स्टेजिंग और विकास के लिए अलग कुंजियाँ उपयोग करें।
लीक होने पर प्रतिक्रिया
तुरंत निरस्त करेंयदि कुंजी लीक हो तो कार्यस्थान से नई कुंजी बनाएँ।

Authentication errors

हेडर अनुपस्थित
Authorization हेडर नहीं दिया गया
गलत प्रारूप
हेडर Bearer से शुरू नहीं होता
अमान्य कुंजी
कुंजी नहीं मिली, निरस्त है या विकृत है
बहुत अधिक विफलताएँ
बार-बार विफल auth प्रयास दर-सीमित हो सकते हैं
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

Next steps

फिर इसे अपने वर्कफ़्लो से जोड़ें।पढ़ना जारी रखें