Referencia API

Actualizar campaña

Actualiza campos permitidos de una campaña de la organización; se aplican permisos y reglas de estado.

PATCHhttps://api.sparkglim.net/api/white-label/v1/campaigns/:campaignId

Modelo de acceso

Modelo de acceso: HMAC de Organización en el servidor
Permiso requerido: campaigns:write
Disponibilidad documentada: Implementado en código

Disponibilidad verificada en el código, sin garantía de producción.

La firma privada permanece en su servidor. La API Versión 1 usa firma v2; no es una API v2.

Encabezados

Nombre	Tipo	Validación
`x-white-label-domain`Obligatorio Dominio verificado que resuelve la cuenta de Organización aprobada y vincula esta solicitud.	`string`	Validación: Nombre de host HTTPS verificado.
`x-white-label-key-id`Obligatorio Identificador extraído de la clave privada única; nunca envíe el secreto en esta cabecera.	`string`	Validación: Identificador interno de la clave privada emitida.
`x-white-label-signature-version`Obligatorio Selecciona la firma vinculada al dominio; las rutas API siguen en Versión 1.	`string`	Validación: 2.
`x-white-label-timestamp`Obligatorio Momento de firma en milisegundos comparado con el reloj del servidor para rechazar solicitudes caducadas.	`string`	Validación: Milisegundos de 13 dígitos; dentro de cinco minutos.
`x-white-label-nonce`Obligatorio Valor aleatorio nuevo registrado por el servidor para impedir repetir una solicitud firmada.	`string`	Validación: Valor nuevo: 16–128 [A-Za-z0-9_-].
`x-white-label-signature`Obligatorio HMAC-SHA256 de dominio, clave de idempotencia, credencial de campaña, instante, nonce, método, ruta, consulta ordenada y hash exacto del cuerpo.	`string`	Validación: HMAC-SHA256 hexadecimal en minúsculas.
`x-white-label-campaign-key`Opcional Clave de campaña completa opcional que limita la solicitud privada a la misma campaña autorizada.	`string`	Validación: Valor keyId:secret completo, opcional y limitado a su ámbito.

Parámetros

Nombre	Tipo	Validación
`campaignId`Obligatorio Campaña existente dentro de la cuenta y del alcance más limitado de la credencial.	`string`	Validación: UUID o identificador de recurso documentado.

Solicitud

Nombre	Tipo	Validación
`title`Opcional Título público de campaña del organizador autorizado.	`string`	Validación: 3–255.
`description`Opcional Descripción del organizador que explica campaña o entrada.	`string`	Validación: 10–5000.
`campaign_type`Opcional Selecciona entradas, votación o donativos; no concede módulos no autorizados.	`enum`	Validación: ticketing \| voting \| donation.
`start_date`Opcional Fecha de apertura de campaña en formato ISO.	`string`	Validación: Fecha y hora en formato ISO.
`end_date`Opcional Fecha de cierre de campaña en formato ISO.	`string`	Validación: Fecha y hora en formato ISO.
`country_code`Opcional Código del país vendedor configurado; servidor comprueba cuenta y mercado.	`string`	Validación: ISO2.
`currency_code`Opcional Moneda permitida de campaña; elegir país no autoriza moneda nueva.	`string`	Validación: ISO3.
`slug`Opcional Identificador de URL para campaña o artículo publicado existente.	`string`	Validación: Esquema configurado del identificador URL.
`status`Opcional Estado admitido solicitado; aprobación controla publicación y acceso.	`enum`	Validación: draft \| pending_approval \| approved \| rejected \| archived.
`vote_price`Opcional Valor configurado del producto en moneda o unidad de capacidad de campaña.	`number`	Validación: >=0.
`donation_goal`Opcional Valor configurado del producto en moneda o unidad de capacidad de campaña.	`number`	Validación: >=0.
`ticket_price`Opcional Valor configurado del producto en moneda o unidad de capacidad de campaña.	`number`	Validación: >=0.
`ticket_capacity`Opcional Valor configurado del producto en moneda o unidad de capacidad de campaña.	`integer`	Validación: >0.
`image_url`Opcional URL de imagen proporcionada; use medios públicos autorizados.	`string\|null`	Validación: URL.
`banner_url`Opcional URL de portada proporcionada por el organizador.	`string\|null`	Validación: URL.
`category`Opcional Categoría de campaña o configuración aprobada según recurso.	`string\|null`	Validación: <=120.
`location`Opcional Ubicación pública o filtro; separado del país vendedor financiero.	`string\|null`	Validación: <=255.
`event_date`Opcional Fecha y hora del evento, distintas del período de venta.	`string\|null`	Validación: Fecha y hora en formato ISO.
`verification_required`Opcional Define verificación admitida sin eludir controles del servidor.	`boolean`	Validación: Valor predeterminado: true.
`metadata`Opcional Metadatos JSON admitidos; nunca sustituyen autorización, precios o propiedad.	`object`	Validación: Objeto JSON.

Solicitud

Los ejemplos describen el contrato y no se ejecutan. Use registros de prueba autorizados; nunca pegue secretos reales aquí.

PATCH /api/white-label/v1/campaigns/:campaignId

http

PATCH /api/white-label/v1/campaigns/11111111-1111-4111-8111-111111111111 HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
Content-Type: application/json

{
  "title": "Updated example campaign"
}

Respuesta

Respuesta correcta · HTTP 200

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  },
  "requestId": "wlapi_example"
}

Respuesta de error · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

Validación, permisos, registros no disponibles y fallos usan el estado HTTP y error del controlador.

Límites y reintentos

Organización: 120 solicitudes por clave y 300 por IP por ventana; respete Retry-After y X-RateLimit.

Compatibilidad del código

Las operaciones autorizadas requieren pruebas específicas de la cuenta.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/auth.ts
server/src/white-label/schemas.ts
server/src/white-label/organization-service.ts
server/src/white-label/service.ts

Modelo de acceso

Encabezados

Parámetros

Solicitud

Solicitud

Respuesta

Límites y reintentos

Compatibilidad del código

Seguir desarrollando