Autenticación de la API de SpeakNotes

Claves de API

Envía la clave como un token de portador (bearer token) en cada solicitud. Cualquier cuenta iniciada puede crear una y funciona de inmediato.

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

Las claves en vivo comienzan con sn_live_ y actúan sobre tu biblioteca real. Las claves de entorno de pruebas comienzan con sn_test_ y se ejecutan contra una salida fija. Las claves emitidas antes de que existieran los alcances siguen funcionando y tienen acceso completo.

Alcances (Scopes)

Cada clave y cada token OAuth conlleva alcances. La lectura nunca implica escritura, por lo que una clave con alcance notes:read no puede eliminar nada. Una solicitud a la que le falta un alcance recibe un 403 que indica lo que falta.

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

Límites de tasa

Los límites se cuentan por credencial, no por IP, por lo que una integración no puede agotar a otra. Cada respuesta lleva X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset, y un 429 lleva 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

¿Estás creando algo en lo que otros usuarios de SpeakNotes inician sesión? Usa OAuth en lugar de pedirles que peguen una clave. /developers/oauth