Documentación para desarrolladores
Autenticación y claves de API
Guarda, rota y revoca claves personales o de organización sin exponer credenciales al navegador.
- Dirigido a
- Desarrolladores y administradores de organizaciones
- Antes de empezar
- Acceso al portal de desarrolladores y a un almacén de secretos del servidor
Enviar la clave
Todas las operaciones v1, incluido el catálogo gratuito, requieren exactamente una clave bearer. Las claves actuales empiezan por otmw_live_.
Authorization: Bearer otmw_live_...Envía la solicitud por HTTPS. No pongas la clave en parámetros de consulta ni la registres completa.
Propiedad personal y de organización
| Contexto | Quién la administra | Qué presupuesto usa |
|---|---|---|
| Personal | El desarrollador de la cuenta | Créditos personales |
| Organización | Administrador o rol de desarrollador | Créditos o cuota compartidos de la organización |
Selecciona el contexto correcto antes de crear una clave. Un docente de organización no puede crear ni revocar claves. Un desarrollador de organización puede administrar la API aunque no tenga acceso para crear hojas en la aplicación.
Almacenamiento y alcance
- Guarda el secreto en el administrador de secretos de tu plataforma o en una variable de entorno del servidor. La plataforma conserva solo un hash y no puede volver a mostrar el valor.
- Las claves no tienen permisos granulares: una clave activa puede llamar a todas las operaciones públicas v1 y usa el presupuesto de su propietario. Separa claves por entorno o integración para poder revocarlas de forma independiente.
- No existe un contrato de integración directa desde navegador ni una promesa pública de CORS. El navegador debe llamar a tu backend; tu backend llama a esta API.
- Nunca envíes nombres, correos ni otros datos personales de estudiantes: los campos de la API no los necesitan.
Rotación sin interrupción
- Crea una clave nueva con una etiqueta que incluya el sistema o entorno.
- Actualiza el secreto en tu backend y despliega el cambio.
- Prueba la clave nueva con GET /catalog; la comprobación es gratuita.
- Revoca la clave anterior en el portal y confirma que ya no aparece como activa.