Tổng quan/OpenAPI/xác thực

xác thực

Cài đặt và xác minh khóa API của bạn một cách an toàn.

Đánh giá API Key

Mỗi điểm kết thúc OpenAPI của KPainter ngoại trừ GET /Health sử dụng khóa API của người dùng:

Authorization: Bearer <your_api_key>

Tạo và sao chép một khóa từ API Trang chủ.

Kiểm tra kết nối đầu tiên

curl -s "https://api.kpainter.ai/openapi/v1/me" \  -H "Authorization: Bearer $KPAINTER_API_KEY"

Một câu trả lời thành công mang lại một tài khoản an toàn và tổng hợp kế hoạch. Kiểm tra điều này trước khi tạo nội dung

Chọn khóa an toàn

  • Giữ mỗi chìa khóa trong một cửa hàng bí mật bên máy chủ hoặc kết nối đại lý đáng tin cậy.
  • Đừng bao giờ đặt một khóa trong mã trình duyệt, gói di động, chụp màn hình, hoặc sổ ghi chép.
  • Đừng sử dụng một chìa khóa chia sẻ cho người dùng cuối không liên quan.
  • Không bao giờ echo khóa đầy đủ trong một tin nhắn lỗi.
  • Yêu cầu người dùng kết nối lại sau khi cài đặt lại khóa.

Câu trả lời chung

  • 401: chìa khóa bị mất, không hoạt động hoặc không hoạt động.
  • 403: Tài khoản không thể sử dụng khả năng được yêu cầu.
  • 422: Một trường hoặc kết hợp các thông số là vô hiệu.
  • 429: Các yêu cầu quá thường xuyên; tuân theo hướng dẫn trả lời trước khi nghỉ hưu.
  • Tỷ lệ cân bằng không đủ: việc tạo ra báo cáo một trạng thái nghỉ ngơi, ước tính tín dụng và hành động có sẵn. Đừng tạo duplicate.

Tính năng kích hoạt, cài đặt lại và xóa khóa API vẫn còn trên trang web KPainter; OpenAPI không quản lý các khóa.