POST /api/emisores/webhook/{id}/probar/

POST /api/emisores/webhook/{id}/probar/

Manda un aviso de prueba al webhook y devuelve lo que respondió.

POST /api/emisores/webhook/{id}/probar/. Va a la misma URL y con la misma firma que los avisos reales, con {"tipo": "prueba", "cliente": <referencia_externa>}. El receptor comprueba la firma y que el cliente exista, y responde sin tocar nada.

Responde 200 con el resultado aunque el receptor falle: entregado es true solo si contestó 200. Lo habitual: 401 es secreto distinto o reloj desfasado; 404, que el receptor no conoce la referencia_externa; codigo_http nulo, que la URL no respondió (el motivo va en detalle). Es 400 si el webhook no tiene secreto o el emisor no tiene referencia_externa: entonces no se manda nada.

No deja registro en /api/emisores/webhook-aviso/.

operationId: emisores_webhook_probar_create

Autenticación

Cualquiera de estas credenciales:

• LlaveApi — Llave de API de una integración. El valor completo es Api-Key <prefijo>.<secreto>, tal como lo imprime manage.py crear_llave_api. La llave alcanza exactamente los mismos emisores que la persona a cuyo nombre se creó.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	path	integer	sí	Un valor de entero único que identifique este webhook.

Ejemplo

curl -X POST "https://api.rededoc.uk/api/emisores/webhook/<id>/probar/" \
  -H "Authorization: <llaveapi>"

Respuestas

Código	Descripción
200
400
401	Error
404	Error
429	Error

200 — cuerpo

Campo	Tipo	Descripción
entregado	boolean
codigo_http	integer	Admite null.
detalle	string
duracion_ms	integer

{
  "entregado": true,
  "codigo_http": 1,
  "detalle": "texto",
  "duracion_ms": 1
}

400 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

401 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

404 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

429 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}