Ir a la documentación
SparkGlimDeveloper
Centro de integración con IA
SparkGlimSparkGlim Desarrolladores
Buscar en toda la documentación

Prueba un tema en tu idioma o una ruta API exacta.

    Navegación de documentación

    Referencia API

    Encolar notificación configurada

    Envía email o SMS habilitado con remitente configurado y devuelve registro y resultado de entrega.

    POSThttps://api.sparkglim.net/api/white-label/v1/notifications

    Modelo de acceso

    Modelo de acceso
    HMAC de Organización en el servidor
    Permiso requerido
    notifications: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

    NombreTipoValidación
    x-white-label-domainObligatorio

    Dominio verificado que resuelve la cuenta de Organización aprobada y vincula esta solicitud.

    		stringValidación: Nombre de host HTTPS verificado.
    x-white-label-key-idObligatorio

    Identificador extraído de la clave privada única; nunca envíe el secreto en esta cabecera.

    		stringValidación: Identificador interno de la clave privada emitida.
    x-white-label-signature-versionObligatorio

    Selecciona la firma vinculada al dominio; las rutas API siguen en Versión 1.

    		stringValidación: 2.
    x-white-label-timestampObligatorio

    Momento de firma en milisegundos comparado con el reloj del servidor para rechazar solicitudes caducadas.

    		stringValidación: Milisegundos de 13 dígitos; dentro de cinco minutos.
    x-white-label-nonceObligatorio

    Valor aleatorio nuevo registrado por el servidor para impedir repetir una solicitud firmada.

    		stringValidación: Valor nuevo: 16–128 [A-Za-z0-9_-].
    x-white-label-signatureObligatorio

    HMAC-SHA256 de dominio, clave de idempotencia, credencial de campaña, instante, nonce, método, ruta, consulta ordenada y hash exacto del cuerpo.

    		stringValidación: HMAC-SHA256 hexadecimal en minúsculas.
    x-white-label-campaign-keyOpcional

    Clave de campaña completa opcional que limita la solicitud privada a la misma campaña autorizada.

    		stringValidación: Valor keyId:secret completo, opcional y limitado a su ámbito.

    Solicitud

    NombreTipoValidación
    channelObligatorio

    Canal de entrega o integración admitido por operación y configuración habilitada.

    		enumValidación: email | sms.
    eventTypeObligatorio

    Evento, asunto o datos de notificación admitidos por flujo de entrega habilitado.

    		stringValidación: 1–120.
    recipientObligatorio

    Contacto destinatario de notificación permitida o desafío de verificación.

    		stringValidación: 3–255.
    subjectOpcional

    Evento, asunto o datos de notificación admitidos por flujo de entrega habilitado.

    		string|nullValidación: <=255.
    payloadOpcional

    Evento, asunto o datos de notificación admitidos por flujo de entrega habilitado.

    		objectValidación: Datos de evento configurados.

    Solicitud

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

    POST /api/white-label/v1/notifications
    http
    POST /api/white-label/v1/notifications 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

{
  "channel": "email",
  "eventType": "<CONFIGURED_EVENT>",
  "recipient": "member@example.com",
  "payload": {}
}

    Respuesta

    Respuesta correcta · HTTP 202
    json
    {
  "success": true,
  "data": {
    "record": {
      "id": "11111111-1111-4111-8111-111111111111"
    },
    "result": {}
  },
  "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

    Seguir desarrollando