Xác thực API SpeakNotes

Khóa API

Gửi khóa dưới dạng bearer token trong mọi yêu cầu. Bất kỳ tài khoản đã đăng nhập nào cũng có thể tạo khóa và nó hoạt động ngay lập tức.

curl https://api.speaknotes.io/v1/notes \
  -H "Authorization: Bearer sn_live_YOUR_API_KEY"

Khóa thực bắt đầu bằng sn_live_ và tác động lên thư viện thực của bạn. Khóa sandbox bắt đầu bằng sn_test_ và chạy với kết quả cố định. Các khóa được cấp trước khi có phạm vi vẫn hoạt động và có toàn quyền truy cập.

Phạm vi

Mỗi khóa và mỗi mã thông báo OAuth đều mang theo các phạm vi. Đọc không bao giờ có nghĩa là ghi, vì vậy một khóa có phạm vi notes:read không thể xóa bất cứ thứ gì. Một yêu cầu thiếu phạm vi sẽ nhận được mã 403 nêu rõ những gì còn thiếu.

• notes:readRead notes, transcripts, and summaries.
• notes:writeCreate, update, and delete notes.
• folders:readRead folders.
• folders:writeCreate, update, and delete folders.
• transcriptions:writeTranscribe audio and video.
• summaries:writeGenerate summaries from audio, text, and YouTube URLs.
• usage:readRead credit balance and usage history.

Giới hạn tốc độ

Giới hạn được tính theo thông tin xác thực, không phải theo IP, vì vậy một tích hợp không thể làm cạn kiệt tích hợp khác. Mỗi phản hồi đều mang theo X-RateLimit-Limit, X-RateLimit-Remaining và X-RateLimit-Reset, và mã 429 mang theo Retry-After.

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="SpeakNotes API", error="invalid_token",
  resource_metadata="https://api.speaknotes.io/.well-known/oauth-protected-resource"

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_token",
    "message": "The API key is invalid, expired, or revoked.",
    "doc_url": "https://speaknotes.io/developers/errors#invalid_token"
  }
}

OAuth

Xây dựng thứ gì đó mà người dùng SpeakNotes khác đăng nhập vào? Hãy sử dụng OAuth thay vì yêu cầu họ dán khóa. /developers/oauth