Skip to main content

​
Qué es

YCloud utiliza claves de API para identificar tu cuenta y autorizar las solicitudes de la API. Envía la clave únicamente desde código seguro del lado del servidor.

​
Antes de comenzar

Crea o recupera una clave de API en tu cuenta de YCloud. Decide dónde almacenará cada entorno su secreto antes de agregar la clave al código de tu aplicación.

​
Solicitud

Envía la clave en el encabezado X-API-Key en cada solicitud.
No agregues el prefijo Bearer. El valor del encabezado es la propia clave de API.

​
Respuesta

Las credenciales válidas permiten que el endpoint devuelva su respuesta de éxito habitual. Las credenciales no válidas o no autorizadas devuelven una respuesta de error 4xx.

​
Almacenar claves de forma segura

  • Guarda las claves de API en un gestor de secretos o en una variable de entorno encriptada.
  • Utiliza claves de API únicamente en código seguro del lado del servidor.
  • Nunca coloques una clave en una URL, paquete de navegador, aplicación móvil, registro o captura de pantalla.
  • Utiliza claves independientes para diferentes entornos cuando la configuración de tu cuenta lo permita.
  • Rota una clave inmediatamente si crees que ha sido expuesta.
Para el desarrollo local, exporta la clave en tu terminal:
Léela desde el entorno en tu aplicación. No la incluyas de forma fija en el código.

​
Rotar una clave

Crea o selecciona la clave de reemplazo, impleméntala en cada servicio que llame a YCloud, verifica el tráfico con la nueva clave y luego revoca la clave antigua. Si sospechas que fue expuesta, rótala primero e investiga después.

​
Solucionar problemas de autenticación

Un fallo de autenticación devuelve una respuesta 4xx. Comprueba que:
  • La solicitud utilice https://api.ycloud.com/v2.
  • El nombre del encabezado sea exactamente X-API-Key.
  • La clave no contenga espacios adicionales ni comillas.
  • La clave esté activa y pertenezca a la cuenta de YCloud prevista.
  • La cuenta tenga acceso al producto utilizado por el endpoint.
Registra el requestId de la respuesta para solucionar problemas, pero nunca registres la clave de API. Consulta Errores para conocer el formato de respuesta.

Probar la autenticación

Verifica una clave con una solicitud de solo lectura a la API de saldo (Balance API).