Referencia API

Iniciar donativo público

Inicia donativo tras validar importe, reglas y protección; no es contribución completada.

POSThttps://api.sparkglim.net/api/public/donate

Modelo de acceso

Modelo de acceso: Acceso público con validación
Disponibilidad documentada: Implementado en código

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

Abra la URL de pago devuelta. SparkGlim Server controla precios, métodos, verificación y entrega; el retorno del navegador solo navega.

Solicitud

Nombre	Tipo	Validación
`campaign_id`Obligatorio Campaña existente dentro de la cuenta y del alcance más limitado de la credencial.	`string`	Validación: UUID.
`amount`Obligatorio Importe solicitado en la moneda de campaña o cuenta; el servidor valida autoridad financiera y condiciones finales.	`number`	Validación: 1–1000000; incrementos de 0.01 en la moneda de campaña.
`donor_country_code`Opcional País del donante, separado del país vendedor y moneda de recaudación.	`string`	Validación: Código ISO2 en mayúsculas.
`email`Opcional Correo de contacto usado por el flujo configurado; por sí solo no concede acceso.	`string`	Validación: Correo electrónico.
`phone_number`Opcional Teléfono del participante; métodos y reglas pueden exigir número internacional válido.	`string`	Validación: Teléfono válido cuando el canal lo requiere.
`donor_name`Opcional Nombre visible del miembro o colaborador; no cambia propiedad de cuenta.	`string`	Validación: Sin espacios en los extremos.
`anonymous`Opcional Solicita contribución anónima existente; no envíe campos contradictorios.	`boolean`	Validación: No debe contradecir is_anonymous.
`is_anonymous`Opcional Solicita contribución anónima existente; no envíe campos contradictorios.	`boolean`	Validación: No debe contradecir anonymous.
`custom_data`Opcional Respuestas a campos reales de campaña, valores requeridos y opciones admitidas.	`object`	Validación: Campos personalizados configurados.
`payment_channel`Opcional Preferencia opcional; solo se usan métodos habilitados para país vendedor, moneda y comercio reales.	`enum`	Validación: Solo el método configurado.
`network_code`Opcional Red móvil configurada cuando el método de pago la requiere.	`string`	Validación: Red configurada.
`is_app`Opcional Contexto existente para elegir configuración web o app; sin permisos extra.	`boolean`	Validación: Contexto del cliente.
`web_abuse_context`Obligatorio Datos existentes de protección del navegador requeridos antes del pago público; no sustituyen autorización del servidor.	`object`	Validación: Objeto estricto; JSON de device_details <=12000 caracteres.
`web_abuse_context.device_id`Obligatorio Señal existente de protección del navegador admitida por esquema actual.	`string`	Validación: 12–160.
`web_abuse_context.device_fingerprint`Obligatorio Señal existente de protección del navegador admitida por esquema actual.	`string`	Validación: 12–160.
`web_abuse_context.browser_signature`Opcional Señal existente de protección del navegador admitida por esquema actual.	`string\|null`	Validación: 12–160.
`web_abuse_context.hardware_signature`Opcional Señal existente de protección del navegador admitida por esquema actual.	`string\|null`	Validación: 12–160.
`web_abuse_context.device_details`Opcional Señal existente de protección del navegador admitida por esquema actual.	`object`	Validación: Objeto JSON.
`web_abuse_context.client_pattern_detected`Opcional Señal existente de protección del navegador admitida por esquema actual.	`boolean`	Validación: Protección de dispositivo existente.
`client_attempt_id`Opcional Identificador estable usado para recuperar un intento y rechazar reintentos incompatibles.	`string`	Validación: Identidad de operación normalizada y estable.
`return_path`Opcional Destino relativo de retorno al sitio actual verificado tras el pago centralizado.	`string`	Validación: Ruta relativa del mismo origen; sin // ni barra inversa.

Solicitud

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

POST /api/public/donate

http

POST /api/public/donate HTTP/1.1
Host: api.sparkglim.net
Content-Type: application/json

{
  "campaign_id": "11111111-1111-4111-8111-111111111111",
  "amount": 10,
  "anonymous": true,
  "web_abuse_context": {
    "device_id": "<EXISTING_DEVICE_ID>",
    "device_fingerprint": "<EXISTING_DEVICE_FINGERPRINT>"
  },
  "client_attempt_id": "example_stable_attempt_0001"
}

Respuesta

Respuesta correcta · HTTP 200

json

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

Respuesta de error · HTTP 400

json

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

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

Límites y reintentos

Límite predeterminado: 100 solicitudes por IP en 60 segundos. También se aplican controles específicos.

Compatibilidad del código

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

server/src/api/router.ts
server/src/api/routes/public.ts

Modelo de acceso

Solicitud

Solicitud

Respuesta

Límites y reintentos

Compatibilidad del código

Seguir desarrollando