Acceso a la API

#Descripción general

La consola de Yeap Cloud funciona con un conjunto de API JSON sobre HTTPS. Esta página explica dónde se encuentra la API, cómo funciona la autenticación y cuáles son las limitaciones actuales del acceso programático.

#Endpoint de la API

https://api.yeap.cloud

• Los endpoints de autenticación se encuentran en /auth/..., por ejemplo, /auth/login y /auth/refresh-token.
• Los endpoints que requieren un usuario con sesión iniciada se encuentran en /api/user/..., por ejemplo, /api/user/profile.

Las solicitudes y las respuestas usan JSON. Envíe Content-Type: application/json con los cuerpos de las solicitudes.

#Autenticación

#Token de acceso

Al iniciar sesión en la consola, el servidor emite un token de acceso (un JWT). Para llamar a los endpoints de /api/user/..., envíelo en el encabezado de la solicitud:

Authorization: Bearer <access-token>

• Los tokens de acceso son válidos durante unas 24 horas.
• Si el token falta, no es válido o ha caducado, la API devuelve HTTP 401:

{"error": "Unauthorized", "code": 401}

• Si se desactiva una cuenta, los tokens que ya se le habían emitido dejan de funcionar inmediatamente.
• Al cerrar sesión en la consola, se invalida el token de acceso actual y se revocan los tokens de actualización de la cuenta.

#Token de actualización

Si marca Recordarme al iniciar sesión, el servidor también emite un token de actualización válido durante 14 días. Cuando caduque su token de acceso, canjee el token de actualización por uno de acceso nuevo en lugar de volver a iniciar sesión:

curl -X POST https://api.yeap.cloud/auth/refresh-token \
  -H "Content-Type: application/json" \
  -d '{"refresh_token": "<refresh-token>"}'

Una respuesta correcta tiene este aspecto:

{"success": true, "token": "<new-access-token>", "user": { ... }}

Si el token de actualización no es válido o ha caducado, la respuesta es {"success": false, "error": "Invalid or expired refresh token"} y debe volver a iniciar sesión. La consola gestiona esta actualización automáticamente.

#El inicio de sesión requiere verificación humana

Cada llamada a /auth/login debe superar una prueba de verificación humana (la consola la muestra en una ventana emergente), y las cuentas con autenticación de dos factores también deben introducir un código de un solo uso. Por tanto, actualmente no es posible iniciar sesión mediante scripts sin intervención humana.

#Ejemplo: consultar su perfil

curl https://api.yeap.cloud/api/user/profile \
  -H "Authorization: Bearer <access-token>"

Una respuesta correcta tiene este aspecto:

{"success": true, "data": {"id": 123, "username": "...", "email": "...", ...}}

La mayoría de los endpoints de usuario devuelven el formato {"success": true, "data": ...}. Los errores devuelven {"success": false, "error": "description"}.

#«Claves de API» en Configuración

La pestaña Perfil → Clave de API permite crear, listar y eliminar claves de API:

1. Introduzca una descripción y haga clic en Generar clave.
2. La clave se muestra una sola vez. Cópiela y guárdela de inmediato en un lugar seguro.
3. La lista Clave existente muestra el ID, la fecha de creación y la fecha del último uso de cada clave. Haga clic en Eliminar para quitar las claves que ya no necesite.

#La página «DNS API» de CDN no es una credencial de Yeap Cloud

CDN → DNS API, en /cdn/dns-api, almacena sus credenciales de API de un proveedor DNS externo (actualmente Cloudflare). Se recomienda un API Token con los permisos Zone.Zone.Read y Zone.DNS.Edit. Estas credenciales se utilizan para obtener automáticamente certificados SSL para los dominios de CDN mediante la validación DNS-01. No tienen relación con el acceso a la API de Yeap Cloud. Consulte la documentación de CDN.

#Claves específicas de cada producto

Algunos productos tienen sus propias claves, independientes de los tokens de la consola descritos en esta página, por ejemplo, API de LLM → Tokens de API. Consulte la documentación de cada producto.

#Recomendaciones de seguridad

• Los tokens de acceso y de actualización equivalen a tener una sesión iniciada. No los comparta ni los incluya en el control de versiones.
• Si cree que se ha filtrado un token, cierre sesión en la consola y cambie su contraseña.
• Active la autenticación de dos factores en su cuenta.