Saltar al contenido principal

Crear una configuración

API operation: Abrir la operación en la Referencia de la API

Usa POST /configs para agregar una configuración de proyecto. La operación pública actual es Config.register.

El contrato del comportamiento descrito requiere una key única. Admite tipos de configuración 1 a 5; los requisitos de value, options e image dependen del tipo seleccionado. Usa el esquema de solicitud de la referencia de la API para consultar el contrato completo de los campos.

En el comportamiento descrito:

  • value es obligatorio a menos que type sea 5.
  • options es obligatorio para los tipos 2, 3 y 4 y se valida como JSON estructurado.
  • image es obligatorio para el tipo 5; si la imagen se procesa correctamente, su resultado se almacena como valor de configuración.
  • La creación de una configuración está restringida a los roles de servidor o administrador representados por el middleware actual.

No coloques credenciales, secretos de proveedores ni datos de clientes en ejemplos. Los valores de configuración protegidos pueden aparecer enmascarados en las respuestas de la API.

Ejemplo de SDK heredado​

const response = await ordering.configs().save(data)

Confirma el paquete y la versión del SDK antes de usar este helper. La operación POST /configs define los campos de solicitud, la autenticación, las respuestas y los errores.

Referencia de OpenAPI​

Operación: POST /configs

Campos del cuerpo de la solicitud

NombreTipoObligatorio
imageanyNo
keyanySí
optionsstringNo
typeintegerNo
valueanyNo

Respuestas

CódigoDescripción
200Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON.
400Respuesta de error (error=true). Los errores de validación y de negocio comparten este código.
401Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa.
404Respuesta vacía: la versión de API solicitada no está admitida.
429Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key.
500Respuesta de error: falló la búsqueda o inicialización del proyecto.
503Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1).
Abrir esta operación en la Referencia de la API