Obtener configuraciones

API operation: Open the endpoint in Scalar

Usa GET /configs para listar las configuraciones visibles para el solicitante. La operación es Config.findAll.

Respuesta de lista sin modo

Sin mode, la operación devuelve result como un arreglo. dictionary no se aplica de forma predeterminada.

{
  "error": false,
  "result": [
    {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  ]
}

Modo de diccionario

Establece mode=dictionary para devolver un objeto indexado por el valor de key de cada configuración en lugar de un arreglo:

GET /configs?mode=dictionary

{
  "error": false,
  "result": {
    "example_setting": {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  }
}

El modo de diccionario excluye las configuraciones exclusivas de v2 y omite description de los registros del modelo. mode=dashboard no es un alias del modo de diccionario.

Visibilidad y acceso

Los solicitantes que no sean administradores ni servidores pueden ver únicamente configuraciones con public=true y hidden=false, con excepciones para plugins y administradores de negocio. Las solicitudes pueden usar una clave de API o un token bearer; no des por hecho que el acceso anónimo esté habilitado.

Las configuraciones protegidas pueden devolver PROTECT en lugar de su valor almacenado. Nunca uses ejemplos de documentación para exponer o inferir valores protegidos.

Ejemplo de SDK heredado

const list = await ordering.configs().get()
const dictionary = await ordering.configs().asDictionary().get()

Los nombres y argumentos de los helpers del SDK pueden diferir según la versión.