SpeakNotes API kimlik doğrulaması

API anahtarları

Anahtarı her istekte bir bearer token olarak gönderin. Oturum açmış her hesap bir tane oluşturabilir ve hemen çalışır.

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

Canlı anahtarlar sn_live_ ile başlar ve gerçek kütüphaneniz üzerinde işlem yapar. Sandbox anahtarları sn_test_ ile başlar ve sabit çıktıya karşı çalışır. Kapsamlar mevcut olmadan önce verilen anahtarlar hala çalışır ve tam erişim sağlar.

Kapsamlar

Her anahtar ve her OAuth belirteci kapsamlar taşır. Okuma asla yazma anlamına gelmez, bu nedenle notes:read kapsamına sahip bir anahtar hiçbir şeyi silemez. Bir kapsamı eksik olan istek, eksik olanı belirten bir 403 hatası alır.

• 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.

Hız sınırları

Sınırlar IP başına değil, kimlik bilgisi başına sayılır, bu nedenle bir entegrasyon diğerini engelleyemez. Her yanıt X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıklarını taşır ve 429 hatası Retry-After başlığını içerir.

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

Diğer SpeakNotes kullanıcılarının oturum açtığı bir şey mi geliştiriyorsunuz? Onlardan bir anahtar yapıştırmalarını istemek yerine OAuth kullanın. /developers/oauth