ข้ามไปที่เนื้อหา
TurnitPass
นักพัฒนาAPI v1รับคีย์ API
ดูเอกสาร

นักพัฒนาการยืนยันตัวตน

ยืนยันตัวตนด้วยคีย์ API

คำขอสำหรับการพัฒนาจะใช้คีย์ API ที่สร้างขึ้นจากพื้นที่ทำงาน TurnitPass

REST API v1

Auth console

เก็บคีย์ API ไว้นอกเบราว์เซอร์

การเรียก API ของ TurnitPass ใช้คีย์ 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' })
})
ยืนยันตัวตนล้มเหลว
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
คีย์ไม่ถูกต้อง
ไม่พบคีย์ ถูกเพิกถอน หรือผิดรูปแบบ
ล้มเหลวมากเกินไป
การยืนยันตัวตนที่ล้มเหลวซ้ำอาจถูกจำกัดอัตรา
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

Next steps

จากนั้นเชื่อมเข้ากับเวิร์กโฟลว์ของคุณอ่านต่อ