Permisos
Cada permiso es uno solo: works:write no incluye works:read. Si tu aplicación necesita
leer y escribir obras, pide los dos.
| Permiso | Lo que ve la persona | Qué abre |
|---|---|---|
works:read |
Leer tus obras | Listar las obras propias, leer una entera (borradores incluidos) y consultar su estado |
works:write |
Crear y actualizar tus obras | Crear obras, publicar versiones nuevas y pedir correcciones |
feedback:read |
Leer tus correcciones | Listar las correcciones recibidas, leer cada una con su cuestionario y el texto que se corrigió |
credits:read |
Consultar tu saldo | Leer el saldo y si alcanza para recibir una corrección de cada capítulo |
Ningún permiso permite mover créditos, ver obras o correcciones de otras personas, ni cambiar el perfil o los ajustes de la cuenta.
Qué operación pide qué
Sección titulada «Qué operación pide qué»| Operación | Permiso |
|---|---|
GET /connect/me |
cualquiera |
GET /connect/works |
works:read |
GET /connect/works/{workId} |
works:read |
GET /connect/works/{workId}/status |
works:read |
POST /connect/works |
works:write |
POST /connect/works/{workId}/revisions |
works:write |
POST /connect/works/{workId}/correction-opening |
works:write |
GET /connect/corrections |
feedback:read |
GET /connect/corrections/{correctionId} |
feedback:read |
GET /connect/corrections/{correctionId}/chapter-text |
feedback:read |
GET /connect/credits/balance |
credits:read |
GET /connect/works/{workId}/correction-affordability |
credits:read |
Todas las rutas son relativas a https://api.lectoresbeta.com/api/v1.
Cómo pedirlos
Sección titulada «Cómo pedirlos»En el parámetro scope de la autorización, separados por espacios:
scope=works:read works:write feedback:read- Un permiso que no existe se rechaza (
invalid_scope), no se ignora. - Un permiso que tu aplicación no tiene permitido también (
invalid_scope). - Lo concedido vuelve en el campo
scopede la respuesta de tokens. Compruébalo. - Si más adelante necesitas otro permiso, vuelve a pedir autorización con la lista completa: se suma a lo que la persona ya había concedido.
- Al renovar puedes pedir menos con
scope, nunca más.
Si falta el permiso
Sección titulada «Si falta el permiso»HTTP/1.1 403 ForbiddenWWW-Authenticate: Bearer error="insufficient_scope", scope="works:read"Content-Type: application/problem+json
{ "status": 403, "code": "INSUFFICIENT_SCOPE", "detail": "…" }La cabecera dice qué permiso hace falta. No renueves el token por esto: no lo arregla. Pide autorización otra vez incluyendo ese permiso, o desactiva la función en tu aplicación.
Cuenta sin activar
Sección titulada «Cuenta sin activar»Las operaciones que escriben (POST) exigen además que la cuenta de la persona esté activada,
como en la propia plataforma. Si no lo está responden 403 ACCOUNT_NOT_ACTIVATED. En la práctica
es raro, porque para autorizar una aplicación ya hace falta la cuenta activada.