Bỏ qua đến nội dung
TurnitPass
Nhà phát triểnAPI v1Tạo khóa API
Xem tài liệu

Nhà phát triểnXác thực

Xác thực bằng khóa API

Các yêu cầu phát triển sử dụng khóa API được tạo từ khu vực làm việc TurnitPass.

REST API v1

Auth console

Giữ khóa API ngoài trình duyệt.

Lời gọi API TurnitPass dùng khóa Bearer thuộc khu vực làm việc. Khóa chỉ nằm trong mã máy chủ; bảng điều khiển vẫn là nơi tạo, xoay, thu hồi và xem mức dùng.

Hàng rào khóa

Cách giữ quyền truy cập an toàn

Chỉ máy chủ

Gửi khóa từ route backend, worker, job hoặc server action bảo mật.

Hiện một lần

Sao chép khóa vừa tạo ngay và lưu vào trình quản lý secret.

Xoay an toàn

Triển khai khóa thay thế trước khi thu hồi khóa production cũ.

Theo tài khoản

Mức dùng được cộng vào số từ còn lại và kiểm soát thanh toán của khu vực làm việc.

Yêu cầu Bearer

Hợp đồng header

Riêng tư mặc định
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 thất bại
failed auth
401
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}
01Tạo trong khu vực làm việc
02Lưu vào secret
03Gọi từ máy chủ
04Xoay hoặc thu hồi

Khóa API

Gửi khóa API cùng với mỗi yêu cầu. Khóa chỉ hiển thị một lần và có thể thu hồi từ khu vực làm việc.

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

POST /api/v1/humanize
Khóa hiện một lần khi tạo và có thể thu hồi từ khu vực làm việc mà không đổi tài khoản Google.

Managing keys

01

Tạo

Tạo khóa có tên từ khu vực làm việc và sao chép ngay.

02

Thu hồi

Vô hiệu hóa khóa ngay lập tức. Khóa đã thu hồi không dùng cho yêu cầu mới.

03

Giới hạn tốc độ

Mỗi khóa có thể bị giới hạn độc lập, trong khi mức dùng vẫn cộng vào tài khoản.

04

Thanh toán

Mọi khóa dùng chung số từ còn lại và giới hạn gói của tài khoản.

Thuộc khu vực làm việc

Key lifecycle

1

Tạo khóa có tên

Đặt tên mô tả môi trường hoặc bề mặt, ví dụ Production backend, Staging worker hoặc Internal QA.

2

Sao chép một lần vào kho secret

TurnitPass chỉ hiện khóa lúc tạo. Lưu vào nhà cung cấp triển khai, trình quản lý secret CI hoặc tệp .env local.

3

Theo dõi mức dùng qua status và thanh toán

Mọi khóa dùng chung số từ còn lại; tên khóa giúp nhận ra tích hợp nào đang chạy.

4

Xoay trước khi thu hồi

Tạo khóa thay thế, triển khai, xác nhận lưu lượng ổn, rồi thu hồi khóa cũ từ khu vực làm việc.

Environment setup

Lưu khóa TurnitPass như secret chỉ dành cho máy chủ. Các ví dụ dưới dùng tên chung cho Next.js, Workers, job máy chủ hoặc mọi runtime backend.

.env
server only
TURNITPASS_API_KEY=tp_live_your_api_key
TURNITPASS_API_BASE_URL=https://turnitpass.com/api/v1
Phát triển local
.env.local hoặc trình quản lý secret localDùng khóa không phải production, ngân sách từ nhỏ và tên rõ.
Triển khai preview
Khóa stagingTách lưu lượng preview để job thử nghiệm không tiêu mức dùng production ngoài ý muốn.
Production
Secret chỉ backendChỉ đọc khóa từ mã máy chủ đáng tin. Không bao giờ chuyển sang trình duyệt.

Security best practices

Chỉ phía máy chủ
Không lộ khóa trong mã trình duyệtDùng khóa từ dịch vụ backend, job hoặc route máy chủ bảo mật.
Biến môi trường
Dùng TURNITPASS_API_KEYTránh ghi khóa live vào kiểm soát phiên bản hoặc gói client.
Xoay khóa
Tạo khóa thay thế trước khi thu hồiDùng khóa riêng cho production, staging và phát triển.
Khi bị lộ
Thu hồi ngayTạo khóa mới từ khu vực làm việc nếu khóa bị rò rỉ.

Authentication errors

Thiếu header
Không có header Authorization
Sai định dạng
Header không bắt đầu bằng Bearer
Khóa không hợp lệ
Không tìm thấy, đã thu hồi hoặc sai định dạng
Thất bại quá nhiều
Nhiều lần auth thất bại có thể bị giới hạn tốc độ
401 response
JSON
{
  "error": "Invalid or revoked API key.",
  "code": "invalid_api_key"
}

Next steps

Tiếp theo, gắn vào quy trình của bạn.Đọc tiếp