Credenciales

​

Propósito

​

Acceso desde código

​

Métodos disponibles

​

getByName(name: string)

const credential = await controller.credentials.getByName("nombre_credencial");

​

getById(id: string)

const credential = await controller.credentials.getById("id_credencial");

​

Estructura de una credencial

​

publicAttributes vs privateAttributes

• publicAttributes: datos no sensibles asociados a la credencial. Por ejemplo, en una credencial de tipo API key, aquí puede guardarse el nombre del header HTTP donde debe enviarse la clave, como X-Api-Key o Authorization.
• privateAttributes: datos sensibles almacenados cifrados y entregados ya descifrados en tiempo de ejecución. Aquí puede guardarse la API key, el token o la contraseña.

​

Ejemplo de uso

// Recuperar la credencial por nombre
const credential = await controller.credentials.getByName("mi_api_externa");

// Acceder a los atributos
const headerName = credential.publicAttributes.header_name;
const apiKey = credential.privateAttributes.api_key;

// Usar en una llamada HTTP
const response = await fetch("https://api.ejemplo.com/endpoint", {
  method: "GET",
  headers: {
    [headerName]: apiKey
  }
});

const data = await response.json();
return data;

​

Buenas prácticas

• Recupera credenciales por nombre cuando el código deba ser legible y estable.
• Evita registrar valores de privateAttributes en logs o respuestas.
• Mantén en publicAttributes solo datos que no sean sensibles.
• Prueba la herramienta en Playground antes de publicarla.

​

Próximos pasos