Protocolo de limpieza

El protocolo de limpieza define las reglas que DigiAnt aplica cuando el conductor declara las cargas anteriores al acceder a una instalación. DigiAnt verifica si existe incompatibilidad entre el producto que transportó antes y el que va a cargar o descargar ahora, y determina si se requiere limpieza, si la combinación está prohibida o si puede operar sin restricción.

Cada empresa logística tiene como máximo un protocolo. Se crea en estado inactive y debe activarse explícitamente antes de que DigiAnt comience a aplicar sus reglas.

Ciclo de vida

Transición	Endpoint
Crear (nace como inactive)	POST /cleaning-protocol
inactive → active	POST /cleaning-protocol/{id}/activate
active → inactive	POST /cleaning-protocol/{id}/deactivate
Eliminar (con todo su contenido)	DELETE /cleaning-protocol/{id}

peligro

Eliminar el protocolo borra permanentemente también todas sus categorías, tipos e incompatibilidades.

Campos de configuración

Campo	Tipo	Requerido	Descripción
previousLoadsCount	1 / 2 / 3	✅	Cuántas cargas anteriores debe declarar el conductor al entrar.
companyProtocolEnabled	boolean	✅	Si true, DigiAnt muestra al conductor el PDF del protocolo de empresa antes de la operación.
companyProtocolDocument	PDF	Condicional	Obligatorio cuando companyProtocolEnabled es true.
cleaningConfirmationRequired	boolean	✅	Si true, el conductor debe confirmar explícitamente que ha realizado la limpieza.

aviso

Si companyProtocolEnabled es true y no se adjunta un PDF, la petición devuelve 400.

Origen

Valor	Descripción
erp	Sincronizado desde el ERP a través del Partner API. El source se asigna automáticamente al crear vía Partner API.
native	Creado directamente en DigiAnt.

Gestión vía Partner API

Consultar

GET /partner/cleaning-protocol
X-Partner-API-Key: dpk_live_...

Devuelve el protocolo de tu empresa o 204 No Content si no existe.

Crear

POST /partner/cleaning-protocol
X-Partner-API-Key: dpk_live_...
Content-Type: multipart/form-data

previousLoadsCount=3
companyProtocolEnabled=false
cleaningConfirmationRequired=true

El protocolo se crea en estado inactive. Actívalo cuando las categorías, tipos e incompatibilidades estén configurados.

Actualizar configuración

PUT /partner/cleaning-protocol/{id}/configuration
X-Partner-API-Key: dpk_live_...
Content-Type: multipart/form-data

previousLoadsCount=2
companyProtocolEnabled=true
existingDocumentId=uuid-del-pdf-actual
cleaningConfirmationRequired=true

Para reemplazar el PDF, omite existingDocumentId y adjunta un nuevo fichero en companyProtocolDocument.

Activar / desactivar

POST /partner/cleaning-protocol/{id}/activate
X-Partner-API-Key: dpk_live_...

POST /partner/cleaning-protocol/{id}/deactivate
X-Partner-API-Key: dpk_live_...