Referencia · API de AccesPub 0.11.0

Datos de la organización, créditos, espacio y límites

GET /organization

Respuestas

Consumo de créditos por mes

GET /organization/usage

Parámetros

Respuestas

Claves de la API (sin el secreto)

GET /api-keys

Respuestas

Crear una clave (solo administradores; se muestra entera una sola vez)

POST /api-keys

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Revocar una clave

DELETE /api-keys/{key_id}

Parámetros

Respuestas

Lista de lotes, del más reciente al más antiguo

GET /batches

Parámetros

Respuestas

Crear un lote

POST /batches

Crea un lote vacío. Después se sube cada EPUB con POST /batches/{batch_id}/jobs. Límites por defecto: 50 EPUB y 1 GB por lote, 50 MB por EPUB.

Parámetros

Cuerpo de la petición (obligatorio)

application/json · BatchCreate

Respuestas

Estado de un lote

GET /batches/{batch_id}

Parámetros

Respuestas

Cambiar nombre, revisores o qué hacer con lo pendiente

PATCH /batches/{batch_id}

Parámetros

Cuerpo de la petición (obligatorio)

application/json · BatchUpdate

Respuestas

Borrar un lote y todos sus ficheros

DELETE /batches/{batch_id}

Cancela lo que esté en cola y borra los ficheros. Las decisiones de revisión y los informes se conservan según el contrato (D4) salvo que se pida su borrado. No devuelve créditos ya consumidos.

Parámetros

Respuestas

Finalizar todos los títulos listos del lote

POST /batches/{batch_id}/finalize

Finaliza los títulos sin pendientes (o todos, con allow_pending), o solo los indicados en job_ids. Consume los créditos de cada título finalizado por primera vez (billing.credits_required: uno hasta 150 imágenes y uno más por cada bloque adicional de 150).

Todo o nada: si no hay créditos para todos los títulos pedidos → 402 insufficient-credits con credits_required y credits_available, y no se finaliza ninguno. Para finalizar solo algunos, enviad job_ids.

• Ningún título que cumpla la condición → 409 nothing-to-finalize.
• Un job_ids que no es del lote → 404; uno que no se puede finalizar (pendientes sin allow_pending, en proceso) → 409.

Parámetros

Cuerpo de la petición

application/json · object

Respuestas

Trabajos (títulos) de un lote

GET /batches/{batch_id}/jobs

Parámetros

Respuestas

Subir un EPUB al lote

POST /batches/{batch_id}/jobs

Un EPUB por petición. Se comprueba el tamaño mientras se recibe: si supera el límite, se corta la subida y responde 413 sin guardar nada.

Comprobaciones, por orden: 1. Tamaño del EPUB (50 MB, o el de una subida grande aprobada) → 413. 2. Límites del lote (50 EPUB, 1 GB) → 409 batch-limit-reached. 3. Espacio de la organización (5 GB) → 409 storage-quota-exceeded. 4. Espacio del servidor → 503 con Retry-After. 5. Que sea un EPUB válido como contenedor (ZIP seguro, ≤ 300 MB descomprimido, no de diseño fijo) → 422.

Parámetros

Cuerpo de la petición (obligatorio)

multipart/form-data · object

Respuestas

Estado de un trabajo

GET /jobs/{job_id}

Parámetros

Respuestas

Asignar revisores o corregir datos del título

PATCH /jobs/{job_id}

Parámetros

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Quitar un título del lote y borrar sus ficheros

DELETE /jobs/{job_id}

Parámetros

Respuestas

Volver a procesar el EPUB original

POST /jobs/{job_id}/reprocess

Repite el análisis (por ejemplo, tras una mejora del motor). Las decisiones ya tomadas se conservan y se vuelven a aplicar a los elementos que sigan existiendo (se reconocen por su contenido aunque cambie su id). El historial de decisiones no cambia. No consume crédito; finalizar de nuevo un título ya cobrado tampoco.

• En cola o en proceso → 409 job-not-ready.
• Ficheros caducados → 410 files-expired.

Parámetros

Respuestas

Informe del análisis en JSON

GET /jobs/{job_id}/report

Mismo contenido que el informe del dashboard: correcciones automáticas, problemas que requieren atención, resultado de EPUBCheck y metadatos de accesibilidad. El esquema lleva versión (schema_version); el completo está en report.schema.json. Mientras se analiza → 409 job-not-ready con Retry-After.

Parámetros

Respuestas

Metadatos del título y lo que conviene completar

GET /jobs/{job_id}/metadata

Campos Dublin Core del OPF (con su origen: el EPUB o un valor indicado aquí), resumen de accesibilidad propio, ISBN de la edición impresa y avisos (notices). Equivale a la pantalla de exportación y a los avisos del informe del dashboard. Mientras se analiza → 409 job-not-ready.

Parámetros

Respuestas

Completar o corregir metadatos

PATCH /jobs/{job_id}/metadata

Solo se cambian los campos enviados; null quita el valor indicado y vuelve al del EPUB. Se guardan aparte y se aplican al finalizar (así sobreviven a reprocesar). No bloquean la finalización ni la conformidad.

• dc.date: AAAA, AAAA-MM o AAAA-MM-DD (otras formas reconocibles se normalizan). Corrige también la fecha ambigua que avisa date_ambiguous.
• page_source_isbn: ISBN de la edición impresa de la que proceden los números de página (pageBreakSource), 10 o 13 dígitos sin guiones.
• accessibility_summary: sustituye el resumen de accesibilidad generado.
• El idioma no se cambia aquí: es el elemento de revisión book_language.
• subjects: materias del libro (thema, bisac, keywords). Sustituyen a todos los dc:subject del EPUB: Thema y BISAC se escriben con su refinamiento EPUB 3 (authority + term) y la etiqueta oficial como texto; las palabras clave, sin refinar. También van al ONIX de accesibilidad (Thema 93, BISAC 10, palabras clave 20). Los Thema se comprueban contra la lista oficial; BISAC = 3 letras + 6 cifras. null vuelve a las materias del EPUB. No se combina con dc.subject.

Todo o nada: con algún campo no válido → 422 y no se guarda nada. En un título finalizado, lo devuelve a ready (finalizar de nuevo no cuesta).

Parámetros

Cuerpo de la petición (obligatorio)

application/json · MetadataUpdate

Respuestas

Pedir a la IA descripción y materias

POST /jobs/{job_id}/metadata/suggestion

Propone una sinopsis, códigos Thema (todos comprobados contra la lista oficial de Thema 1.6, incluidos los calificadores), una pista BISAC en texto y palabras clave, a partir de unos 4.000 caracteres del inicio del cuerpo del libro (sin portada ni créditos) y del título. No se aplica: lo que se acepte se envía con PATCH /jobs/{job_id}/metadata (dc.description y subjects). No consume créditos.

• Solo personas internas (o clave de API); no revisores externos.
• Límite compartido con las propuestas de revisión: limits.ai_suggestions_per_minute → 429 con Retry-After.
• Con una clave ap_test_ la propuesta es fija (provider: test) y no se llama a la IA.
• Sin texto que leer (libro solo de imágenes) o filtros de contenido → 422 ai-blocked. IA saturada o no configurada → 503 ai-unavailable.

Parámetros

Respuestas

Generar el EPUB final (consume un crédito)

POST /jobs/{job_id}/finalize

Aplica las decisiones y los metadatos completados (PATCH …/metadata), escribe los metadatos de accesibilidad, valida con EPUBCheck y genera las salidas. Consume un crédito la primera vez; finalizar de nuevo (tras cambiar decisiones o volver a procesar) no cuesta. Una versión nueva del EPUB, aunque tenga el mismo ISBN, es otro trabajo y otro crédito.

• Si quedan pendientes y allow_pending es false → 409 pending-review.
• Con allow_pending: true se entrega sin dcterms:conformsTo y el informe lista lo pendiente.
• Sin créditos → 402.
• En cola, en proceso o ya finalizándose → 409 job-not-ready.
• Ficheros caducados → 410 files-expired.

Parámetros

Cuerpo de la petición

application/json · object

Respuestas

Elementos que requieren criterio humano

GET /jobs/{job_id}/review-items

Imágenes sin texto alternativo aceptable, tablas, atributos de idioma en línea (language.scope: inline), el idioma de cada documento (language.scope: document) y el idioma principal del libro, con su orden en el OPF (language.scope: book, id: book_language; como el bloque «Idioma principal del epub» del dashboard). Un idioma de documento asignado automáticamente con alta confianza aparece como decidido, con decision.auto: true; también el idioma del libro cuando no hay nada que confirmar pero el libro tiene varios idiomas candidatos (se puede cambiar), o cuando el OPF no tiene un idioma válido y el lote trae defaults.fallback_language. Los decididos por la API llevan decided_by y decided_at. Mientras se analiza → 409 job-not-ready.

Parámetros

Respuestas

Imagen que se revisa (reducida a 1024 px como máximo)

GET /jobs/{job_id}/review-items/{item_id}/image

Las imágenes de más de 1024 px se devuelven reducidas (JPEG, o PNG si tienen transparencia). Los GIF y SVG se devuelven tal cual; los SVG, con una Content-Security-Policy que impide ejecutar scripts.

Parámetros

Respuestas

Pedir una propuesta a la IA

POST /jobs/{job_id}/review-items/{item_id}/suggestion

Devuelve una propuesta: texto alternativo para una imagen o título para una tabla, escrito en el idioma de ese elemento. No se aplica: hay que enviarla como decisión, revisada por una persona (con from_suggestion: true si se parte de ella). Los idiomas no tienen propuesta (422).

• Límite: limits.ai_suggestions_per_minute por organización → 429 con Retry-After.
• Con una clave ap_test_ la propuesta es un texto fijo de prueba (provider: test) y no se llama a la IA.
• La IA no puede leer la imagen (SVG) o sus filtros bloquean el texto → 422 ai-blocked: hay que escribirlo a mano.
• IA saturada o no disponible → 503 ai-unavailable con Retry-After; error del proveedor → 502 ai-error.

Parámetros

Respuestas

Estado de las propuestas de la IA del título

GET /jobs/{job_id}/ai-prefill

Parámetros

Respuestas

Preparar las propuestas de la IA de todas las imágenes y tablas

POST /jobs/{job_id}/ai-prefill

Propuestas masivas. Pone en cola una propuesta para cada imagen pendiente (texto alternativo; no se incluyen los SVG, que la IA no puede leer) y para cada tabla pendiente (título de la tabla) que aún no la tenga. Las propuestas llegan poco a poco: una cola común reparte el ritmo entre las organizaciones y las que se piden a mano pasan delante. Cada propuesta se lee como siempre (review-items con su propuesta) y no se aplica sola: hay que enviarla como decisión revisada por una persona.

Es idempotente: repetirla vuelve a intentar las que fallaron. Lo hace solo, al analizar, si el lote tiene defaults.ai_prefill: true. Con una clave ap_test_ las propuestas son un texto fijo de prueba y no se llama a la IA.

Cobro según la organización (lo fija ab serveis): incluido en el crédito del título (hace falta saldo para finalizarlo; si no, 402) o de pago (créditos por cada bloque de imágenes, cobrados al pedirlas; lo que no se genera se devuelve solo). Las tablas no cuentan en los bloques de pago. Si la función no está activada para la organización → 403.

Parámetros

Respuestas

Saltar la revisión de lo que quede pendiente

POST /jobs/{job_id}/skip-review

Equivale a «Saltar revisión» del dashboard. Lo que quede pendiente de imágenes, tablas e idiomas en línea pasa a decorativo (alt=""), de maquetación (role="presentation") o se conserva (idiomas). Los idiomas de documento y el del libro no se tocan.

• confirm_decorative: true: una persona confirma que lo restante es decorativo o de maquetación. Son decisiones con revisor (reviewer obligatorio), quedan en el historial y cuentan para la conformidad.
• confirm_decorative: false (por defecto): saltado sin revisar. El EPUB sale igual, pero imágenes y tablas siguen pendientes: no se declara conformidad y hay que finalizar con allow_pending.

Parámetros

Cuerpo de la petición

application/json · object

Respuestas

Historial de decisiones de un título

GET /jobs/{job_id}/decisions

Todas las decisiones enviadas, de la más antigua a la más reciente, con su revisor y su fecha (también las sustituidas). Se conserva aunque se borren los ficheros del título.

Parámetros

Respuestas

Enviar decisiones de revisión

POST /jobs/{job_id}/decisions

Una o varias decisiones a la vez (máximo 200 por petición). Se guardan al momento, con revisor y fecha: la revisión puede repartirse entre personas y durar semanas. Enviar otra decisión para el mismo elemento la sustituye (queda el historial).

Todo o nada: si alguna decisión no es válida → 422 invalid-decision con un error por decisión en errors (pointer = /decisions/N/…), y no se guarda ninguna.

Sin persona identificada no hay criterio humano: - Con sesión, el revisor es la persona de la sesión (reviewer se ignora). - Con clave de API, reviewer es obligatorio y su correo tiene que ser el de una persona activa de la organización (cualquier rol, o revisor externo de ese lote); si no, 422 reviewer-not-registered. Por contrato, el cliente responde de la identidad de sus revisores.

AccesPub señala patrones anómalos (decenas de decisiones en pocos segundos, o todas las propuestas de la IA aceptadas sin cambios) en review_flags del trabajo, en el informe y en la consola de ab serveis.

Solo con el trabajo en needs_review, ready o completed; en otro estado → 409 job-not-ready. Una decisión enviada después de finalizar devuelve el trabajo a ready: hay que finalizar de nuevo (sin coste). Si con la decisión ya no queda nada pendiente y el lote tiene auto_finalize, el título se finaliza solo (job_status: finalizing).

Parámetros

Cuerpo de la petición (obligatorio)

application/json · DecisionBatch

Respuestas

Descargar una salida de un título

GET /jobs/{job_id}/files/{kind}

original se puede descargar siempre que no haya caducado; el resto, solo con el título finalizado (si no, 409 job-not-finalized). Ficheros caducados (30 días tras finalizar) → 410 files-expired.

Con naming=isbn, el fichero se llama como el ISBN-13 del título (9788412345674.epub, 9788412345674-informe.html, 9788412345674-onix.xml), como piden las plataformas de distribución. Si el título no tiene un ISBN-13 válido → 409 isbn-missing.

Parámetros

Respuestas

Manifiesto del lote (estado de cada título y cada salida)

GET /batches/{batch_id}/manifest

Parámetros

Respuestas

Descargar las salidas del lote de una vez

GET /batches/{batch_id}/files/{kind}

Solo incluye los títulos finalizados. - epubs: .zip con los EPUB finales. - reports: .zip con un informe HTML por título. - onix_a11y: un único mensaje ONIX 3.1 con un <Product> por título.

Sin ningún título finalizado → 409 job-not-finalized.

Parámetros

Respuestas

Datos comerciales del título, comprobaciones y estado del ONIX comercial

GET /jobs/{job_id}/commercial

title: lo indicado para el título. batch: los valores comunes del lote. effective: lo que se usará (lo del título manda; un campo vacío toma el del lote; los mercados del título, si tiene, sustituyen a los del lote). issues: comprobaciones (level error impide generarlo: not_finalized, isbn_missing, publisher_missing, markets_missing, xsd_invalid; avisos: market_unpriced, date_missing, cover_missing). billing: modo de la organización y lo que costaría generarlo ahora.

Parámetros

Respuestas

Cambiar los datos comerciales del título

PATCH /jobs/{job_id}/commercial

Solo cambian los campos enviados; null (o vacío) quita el valor y vuelve al del lote. markets sustituye la lista entera. No obliga a finalizar de nuevo: el ONIX comercial se construye al descargarlo.

apply_to_batch: nombres de campos comunes que además se guardan como valores del lote (los mercados pasan sin price_amount, que es de cada título). Campos comunes: imprint, collection, pub_status, city, country, copyright_owner, audience, age_from, age_to, supplier_name, supplier_role, markets.

Los códigos se comprueban contra las listas ONIX del esquema oficial 3.1. Todo o nada: con algún campo no válido → 422 con errors y no se guarda nada.

Parámetros

Cuerpo de la petición (obligatorio)

application/json · Commercial + object

Respuestas

Generar el ONIX comercial del título

POST /jobs/{job_id}/onix-full

Comprueba los datos (422 onix-incomplete con jobs[].issues si falta algo) y lo activa para el título. Según la organización puede consumir créditos (billing en GET), una sola vez por título; en modo prueba, nunca. Sin saldo → 402 insufficient-credits. Desactivado para la organización → 403. Volver a llamarlo no cobra de nuevo. Después se descarga con GET /jobs/{id}/files/onix_full, siempre con los datos al día.

Parámetros

Respuestas

Valores comerciales comunes del lote y estado de cada título

GET /batches/{batch_id}/commercial

Parámetros

Respuestas

Cambiar los valores comerciales comunes del lote

PATCH /batches/{batch_id}/commercial

Solo campos comunes (ver PATCH /jobs/{id}/commercial); null quita el valor. También se pueden indicar al crear el lote en defaults.commercial.

Parámetros

Cuerpo de la petición (obligatorio)

application/json · Commercial

Respuestas

Generar el ONIX comercial de los títulos terminados del lote

POST /batches/{batch_id}/onix-full

Todos los títulos terminados del lote, o solo los de job_ids. Todo o nada: si alguno no está listo (422 con jobs[].issues) o no hay saldo para todos (402), no se genera ninguno. Los ya generados no se cobran de nuevo.

Parámetros

Cuerpo de la petición

application/json · object

Respuestas

Solicitudes de subida grande de la organización

GET /large-upload-requests

Respuestas

Pedir permiso para un EPUB de más de 50 MB

POST /large-upload-requests

La revisa ab serveis. Si se aprueba, el lote admite ese fichero (hasta 200 MB) durante 7 días, y cuenta contra el espacio de la organización. Solo administradores y gestores de lotes.

Cuerpo de la petición (obligatorio)

application/json · LargeUploadRequestCreate

Respuestas

Solicitudes de ayuda de un título

GET /jobs/{job_id}/support-requests

Parámetros

Respuestas

Pedir ayuda a ab serveis con un título

POST /jobs/{job_id}/support-requests

Para un EPUB con errores que AccesPub no puede corregir (aviso epubcheck_errors en el título) o que no se ha podido procesar (failed). Es opcional: la editorial puede corregir el EPUB por su cuenta y volver a subirlo.

ab serveis recibe el mensaje con el registro de EPUBCheck y responde en la solicitud (resolution): - fix_planned: es un caso que AccesPub debería contemplar y se incorporará; - publisher_fix: es un problema concreto del EPUB, a corregir por la editorial; - manual_fix_quote: ab serveis puede corregirlo, con presupuesto aparte; - fixed o closed.

Con share_epub: true la editorial autoriza a ab serveis a descargar el EPUB original para diagnosticarlo; si no, solo ve el registro de errores. Como máximo 3 solicitudes abiertas por título (409 too-many-open-requests).

Parámetros

Cuerpo de la petición (obligatorio)

application/json · SupportRequestCreate

Respuestas

Solicitudes de ayuda de la organización

GET /support-requests

Parámetros

Respuestas

Personas de la organización (también invitadas y dadas de baja)

GET /users

Respuestas

Invitar a una persona (solo administradores)

POST /invitations

• admin, batch_manager, reviewer: enlace de un solo uso, válido 72 horas, para crear la contraseña (/invitacion?token=…).
• external_reviewer (con batch_id): enlace de su lote, válido 30 días y reutilizable, sin contraseña (/revision?token=…). Solo ve y decide en ese lote. Se revoca dándolo de baja.

El enlace se envía por correo si el servidor tiene correo configurado (email_sent) y siempre se devuelve en access_url, para que el administrador pueda hacerlo llegar. Es personal. Un correo solo puede pertenecer a una persona activa o invitada (409 email-in-use).

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Aceptar una invitación (o restablecer la contraseña)

POST /invitations/accept

Con el token del enlace. Activa la cuenta con la contraseña (mínimo 10 caracteres) y el nombre, que figurará en las decisiones que firme. Sirve también para el enlace de restablecer la contraseña; en ese caso cierra las sesiones abiertas. Enlace usado o caducado → 400 invalid-token.

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Iniciar sesión con correo y contraseña

POST /sessions

Devuelve la cookie de sesión (ap_session) y el csrf_token. Correo o contraseña incorrectos → 401 (sin decir cuál). Tras 5 intentos fallidos en 15 minutos → 429 con Retry-After. Los revisores externos entran con POST /sessions/link. La sesión se renueva con la actividad: caduca tras 12 horas sin usarse y, como máximo, 7 días después de iniciarse.

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Entrar con el enlace de un lote (revisores externos)

POST /sessions/link

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Cerrar la sesión

DELETE /sessions/current

Respuestas

Quién hace la petición (persona o clave), su rol y su modo

GET /me

Respuestas

Cambiar la propia contraseña (cierra las demás sesiones)

POST /me/password

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Cambiar el rol de una persona (solo administradores)

PATCH /users/{user_id}

admin, batch_manager o reviewer. Los revisores externos no cambian de rol (se invita a la persona de nuevo). No se puede degradar al último administrador (409 last-admin).

Parámetros

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Dar de baja a una persona (solo administradores)

DELETE /users/{user_id}

Quita el acceso y cierra sus sesiones, pero no borra el registro: su nombre sigue en las decisiones de revisión que firmó. Su correo se puede volver a invitar. No se puede dar de baja al último administrador (409 last-admin).

Parámetros

Respuestas

Enlace de acceso al portal para una persona (modelo mixto)

POST /users/{user_id}/sign-in-link

Para que quien revisa salte de vuestra aplicación al portal sin volver a iniciar sesión. Vuestro servidor lo pide justo cuando la persona pulsa «Revisar en AccesPub» y la redirige a url: el portal abre su sesión, en el modo de la clave (real o prueba), y la lleva a next (por ejemplo, el review_url del título). Sus decisiones quedan firmadas por ella.

• Solo con clave de API, desde vuestro servidor (nunca en el navegador ni en una app). Con sesión de persona → 403.
• Hay que pedir que se active para vuestra organización: AccesPub confía en vuestro inicio de sesión para identificar a vuestra gente. Sin activar → 403 sign-in-links-disabled.
• Un solo uso y 5 minutos. Pedidlo en el momento del clic, no por adelantado.
• Sin escalar privilegios: una clave que no es de administración no puede pedirlo para una persona administradora (403).
• La persona tiene que ser de vuestra organización (404) y no estar dada de baja (409 user-deactivated). Una persona invitada que aún no tiene contraseña queda activa al usarlo (ver send_email en POST /invitations).
• next: una ruta del portal (/portal/…) o una dirección completa del portal, como review_url o portal_url. Otra cosa → 422. Sin next, la lista de lotes.
• Cada enlace queda registrado (persona, clave, fecha y destino).

Parámetros

Cuerpo de la petición

application/json · object

Respuestas

Enlace nuevo (reenviar invitación, restablecer contraseña o enlace de lote)

POST /users/{user_id}/access-link

Invalida el enlace anterior del mismo tipo. Para una persona activa con contraseña, el enlace sirve para restablecerla (POST /invitations/accept). Dada de baja → 409 user-deactivated.

Parámetros

Respuestas

Direcciones que reciben avisos (solo administración)

GET /webhook-endpoints

Las del modo de la clave (ap_live_ o ap_test_): cada modo tiene sus propias direcciones y recibe solo sus eventos. Incluye la lista de tipos de evento que se pueden pedir.

Respuestas

Añadir una dirección (devuelve el secreto de firma una sola vez)

POST /webhook-endpoints

Solo https:// y direcciones públicas: se rechazan localhost, nombres sin dominio, IP privadas, locales o de metadatos y URL con usuario o contraseña. Al enviar, la dirección se resuelve de nuevo y se bloquea si apunta a una red privada. Máximo 5 direcciones por modo.

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Una dirección (sin el secreto)

GET /webhook-endpoints/{endpoint_id}

Parámetros

Respuestas

Cambiar la dirección, los eventos o la descripción; desactivar o reactivar

PATCH /webhook-endpoints/{endpoint_id}

enabled: false deja de enviar (lo pendiente queda como failed). enabled: true reactiva una dirección desactivada (también la que AccesPub desactivó por fallar durante días); empieza de cero.

Parámetros

Cuerpo de la petición (obligatorio)

application/json · object

Respuestas

Quitar una dirección (y su historial de envíos)

DELETE /webhook-endpoints/{endpoint_id}

Parámetros

Respuestas

Secreto de firma nuevo (el anterior sigue firmando 24 horas)

POST /webhook-endpoints/{endpoint_id}/rotate-secret

Durante 24 horas cada aviso lleva dos firmas en webhook-signature (la del secreto nuevo y la del anterior), para cambiarlo sin cortes.

Parámetros

Respuestas

Enviar ahora un evento de prueba (webhook.test)

POST /webhook-endpoints/{endpoint_id}/test

Un solo intento, sin reintentos, también si la dirección está desactivada. La respuesta dice si ha llegado (delivered) y qué ha respondido vuestro sistema.

Parámetros

Respuestas

Últimos envíos a una dirección (30 días)

GET /webhook-endpoints/{endpoint_id}/deliveries

Parámetros

Respuestas

Un envío, con el evento enviado

GET /webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}

Parámetros

Respuestas

Volver a enviar un envío (entregado o no entregado)

POST /webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/retry

Se envía en unos segundos con el mismo webhook-id (el mismo evento).

Parámetros

Respuestas

job.needs_review

Un título tiene elementos pendientes de revisión humana

application/json · Event + object

job.ready

Un título ya no tiene nada pendiente: listo para finalizar

application/json · Event + object

job.completed

Un título se ha finalizado y sus salidas están listas

application/json · Event + object

job.failed

Un título no se ha podido analizar (status failed) o finalizar (vuelve a su estado, con error)

application/json · Event + object

job.ai_prefill_done

Han terminado las propuestas de la IA de un título (propuestas masivas)

application/json · Event + object

batch.completed

Todos los títulos del lote están finalizados o con error

application/json · Event + object

large_upload_request.resolved

ab serveis ha aprobado o rechazado una subida grande

application/json · Event + object

support_request.answered

ab serveis ha respondido una solicitud de ayuda

application/json · Event + object

credits.low

El saldo ha bajado del umbral de la organización o se ha agotado (solo live)

application/json · Event + object

webhook.test

Evento de prueba (POST /webhook-endpoints/{endpoint_id}/test)

application/json · Event + object