Documents
Emissió, rectificació i accés als documents propis recents.
Crear document
Envia totes les dades del transport. La resposta es lliura després de generar i emmagatzemar el PDF xifrat.
Una referència no nul·la és única per organització i entorn. Repetir la referència amb les mateixes dades normalitzades i metadata retorna el resultat original dins de 24 hores (200), sense emetre un altre PDF. Una creació nova retorna 201. Dades diferents o una referència d'una altra credencial produeixen 409 sense divulgar documents. Sense referència no es garanteix la deduplicació.
Una referència amb el resultat vençut retorna 409 DOCUMENT_WINDOW_EXPIRED. Si el document està eliminat, no se'n retorna el contingut ni es reutilitza la referència; el reintent retorna 404. Per rectificar, utilitza els endpoints PUT.
Pots sol·licitar un token sk_demo_ sense compte ni alta d’una organització. Dura 24 hores des de l’emissió i només funciona des de la IP pública que l’ha sol·licitat. Si canvies de xarxa o d’IP, cal sol·licitar un altre token. La demo afegeix demo: true, expires_at, qr_url (àlies de url) i pdf_url (àlies de pdf_download_url). document_locale és l’idioma triat en sol·licitar el token (es per defecte). Les dades i PDF temporals estan separats de l’arxiu real i no es xifren com els documents reals.
Crear document › Cos de la petició
transport_dateData real del transport en format YYYY-MM-DD; no és l'instant de creació del PDF.
Carregador contractual; pot ser diferent del magatzem d'origen i del client de DeCA.
Transportista que fa efectivament el transport, inclòs el subcontractat.
Naturalesa i pes de la mercaderia, o magnitud alternativa quan pertoqui. Envia exactament una mesura.
Vehicle efectiu; si hi ha remolc o semiremolc, informa els seus dos camps junts.
reference^[A-Za-z0-9-]+(?![\s…Referència pròpia opcional, única per organització i entorn i impresa al PDF. Identifica els reintents i permet consultar per referència. No s'allibera en eliminar el document.
Autorització especial de circulació quan calgui. Omet-la o envia null si no correspon.
observationsObservacions que els intervinents sol·licitin fer constar al document.
Objecte JSON opcional, conservat i retornat sense modificació semàntica. No s'imprimeix al PDF. Màxim 16 KiB en serialitzar-lo i 8 nivells de profunditat.
Crear document › Respostes
Reintent idempotent; retorna el resultat original sense generar un altre PDF.
Taula d'alternatives
| Alternativa | Criteris de selecció |
|---|---|
| type = object · Camps obligatoris: uuid, reference, created_at +7 més | |
| type = object · Camps obligatoris: uuid, reference, created_at +11 més |
uuidUUID del document emès.
reference^[A-Za-z0-9-]+(?![\s… · obligatoriReferència del client o null.
created_atInstant original de creació, en UTC.
urlURL HTTPS completa de descàrrega per QR, amb el seu secret. No la registris ni publiquis.
pdf_download_urlURL de descàrrega autenticada; requereix el Bearer de la credencial propietària dins de 24 hores.
rectifies_uuidUUID rectificat o null en una emissió inicial.
La mateixa metadata de la petició; null si no s'ha proporcionat.
document_localeIdioma del PDF escollit en emetre'l segons l'organització. Es conserva al resultat; canviar l'idioma de l'organització no modifica documents existents. No canvia camps JSON ni missatges d'error de l'API.
Rectificar document
Identifica el document anterior amb el UUID i envia totes les dades corregides, sense actualitzacions parcials. Només es pot rectificar l'última versió de la mateixa credencial. Es permet rectificar un document de més de 24 hores sense retornar-ne el contingut anterior. Un document eliminat retorna 404 i no es pot rectificar.
Es genera un document rectificatiu amb UUID, PDF i QR nous; es conserven l'original i el seu QR. Lliura el nou PDF al conductor. El camp reference del cos correspon a la nova versió, no al document de la URL.
Repetir el mateix PUT amb les mateixes dades normalitzades i metadata retorna la rectificació ja emesa durant les 24 hores següents a la seva creació, sense generar una altra versió. Aquesta comprovació es fa abans de rebutjar un document ja rectificat i també funciona si el reintent identifica el mateix document per referència. Canviar dades d'un document ja rectificat retorna 409. Un resultat de reintent vençut retorna 409 DOCUMENT_WINDOW_EXPIRED. Si la rectificació retornada està eliminada, el reintent retorna 404. Per a una altra rectificació, utilitza el UUID o la referència de l'última versió.
Paràmetres de ruta
uuidUUID públic del document. Alternativament, utilitza /api/v1/documents/ref/{reference} amb el mateix mètode. Exemple: /api/v1/documents/ref/EXP-2026-004587.
Rectificar document › Cos de la petició
transport_dateData real del transport en format YYYY-MM-DD; no és l'instant de creació del PDF.
Carregador contractual; pot ser diferent del magatzem d'origen i del client de DeCA.
Transportista que fa efectivament el transport, inclòs el subcontractat.
Naturalesa i pes de la mercaderia, o magnitud alternativa quan pertoqui. Envia exactament una mesura.
Vehicle efectiu; si hi ha remolc o semiremolc, informa els seus dos camps junts.
reference^[A-Za-z0-9-]+(?![\s…Referència nova del document rectificatiu, opcional i única per organització i entorn. No reutilitzis la referència del document identificat a la URL.
Autorització especial de circulació quan calgui. Omet-la o envia null si no correspon.
observationsObservacions que els intervinents sol·licitin fer constar al document.
Objecte JSON opcional, conservat i retornat sense modificació semàntica. No s'imprimeix al PDF. Màxim 16 KiB en serialitzar-lo i 8 nivells de profunditat.
Rectificar document › Respostes
Document rectificatiu emès, o resultat d'un reintent idèntic sense crear una altra versió.
Taula d'alternatives
| Alternativa | Criteris de selecció |
|---|---|
| type = object · Camps obligatoris: uuid, reference, created_at +7 més | |
| type = object · Camps obligatoris: uuid, reference, created_at +11 més |
uuidUUID del document emès.
reference^[A-Za-z0-9-]+(?![\s… · obligatoriReferència del client o null.
created_atInstant original de creació, en UTC.
urlURL HTTPS completa de descàrrega per QR, amb el seu secret. No la registris ni publiquis.
pdf_download_urlURL de descàrrega autenticada; requereix el Bearer de la credencial propietària dins de 24 hores.
rectifies_uuidUUID rectificat o null en una emissió inicial.
La mateixa metadata de la petició; null si no s'ha proporcionat.
document_localeIdioma del PDF escollit en emetre'l segons l'organització. Es conserva al resultat; canviar l'idioma de l'organització no modifica documents existents. No canvia camps JSON ni missatges d'error de l'API.
Eliminar document
Esborrament lògic per corregir errors detectats en generar un document, exclusivament abans de lliurar-lo al transportista o al conductor i abans d'utilitzar-lo en un transport. La integració ha de confirmar totes dues condicions; no n'hi ha prou amb estar dins del termini. Si el document ja s'ha lliurat o utilitzat, cal rectificar-lo mitjançant PUT.
Només es permet mentre l'hora del servidor sigui anterior a created_at + 2 hores; a les 2 hores exactes ja no es permet. Ni una consulta ni un reintent reinicien el termini. Cada versió utilitza la seva pròpia data de creació. Només es pot eliminar l'última versió de la credencial autenticada.
Es conserven el PDF, les dades i la traçabilitat, però el document deixa d'aparèixer a la llista. Les consultes per UUID o referència, la descàrrega autenticada, el QR i els reintents que retornarien el contingut responen 404. La consulta d'estat respon només amb status: deleted durant la finestra de consulta de 24 hores. La referència continua reservada. No hi ha endpoint de reactivació; l'esborrament conserva l'arxiu per permetre una recuperació futura.
Repetir DELETE dins de les mateixes 2 hores retorna 204 sense canviar la data d'eliminació. Passat el termini retorna 409.
El primer accés correcte a l'enllaç QR també bloqueja l'esborrament amb 409 DOCUMENT_ALREADY_ACCESSED. Aquest accés no prova per si sol que s'hagi fet el transport.
Paràmetres de ruta
uuidUUID públic del document. Alternativament, utilitza /api/v1/documents/ref/{reference} amb el mateix mètode. Exemple: /api/v1/documents/ref/EXP-2026-004587.
Eliminar document › Cos de la petició
reasonMotiu de l'error detectat en generar el document.
confirm_not_deliveredHa de ser true per eliminar: confirma que no s'ha lliurat al transportista ni al conductor. false retorna 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedHa de ser true per eliminar: confirma que no s'ha utilitzat en un transport. false retorna 409 DOCUMENT_ALREADY_USED.
Eliminar document › Respostes
Document marcat com a eliminat. Sense cos de resposta.
Llistar documents recents
Retorna resums, sense PDF, secret QR ni metadata. El servidor aplica sempre la finestra de 24 hores i l'aïllament de la credencial. Ordre descendent per data de creació i UUID com a desempat, paginació per pàgina i filtres inclusius de data de transport. La finestra s'avalua a cada petició; no constitueix una instantània estable entre pàgines. No permet consultar l'històric.
Els documents eliminats no apareixen a la llista.
Paràmetres de consulta
pagePàgina sol·licitada, a partir d'1.
limitDocuments per pàgina, entre 1 i 100.
fromData de transport mínima, inclosa. No amplia la finestra de lectura.
toData de transport màxima, inclosa; igual o posterior a from.
Llistar documents recents › Respostes
Pàgina de documents recents. Una pàgina sense resultats té data buit.
Consultar document
Recupera el resultat original dins de 24 hores, només per a la credencial que va emetre el document. Inclou tots els camps acceptats i normalitzats i la metadata sense modificació semàntica.
Un UUID o una referència inexistent, d'una altra credencial o fora de la finestra retorna el mateix 404, sense confirmar-ne l'existència ni el propietari. Cada referència identifica la seva pròpia versió i no redirigeix a una rectificació posterior.
Un document eliminat retorna 404. Per saber si està eliminat, utilitza la consulta d'estat.
Paràmetres de ruta
uuidUUID públic del document. Alternativament, utilitza /api/v1/documents/ref/{reference} amb el mateix mètode. Exemple: /api/v1/documents/ref/EXP-2026-004587.
Consultar document › Respostes
Resultat original del document.
Taula d'alternatives
| Alternativa | Criteris de selecció |
|---|---|
| type = object · Camps obligatoris: uuid, reference, created_at +7 més | |
| type = object · Camps obligatoris: uuid, reference, created_at +11 més |
uuidUUID del document emès.
reference^[A-Za-z0-9-]+(?![\s… · obligatoriReferència del client o null.
created_atInstant original de creació, en UTC.
urlURL HTTPS completa de descàrrega per QR, amb el seu secret. No la registris ni publiquis.
pdf_download_urlURL de descàrrega autenticada; requereix el Bearer de la credencial propietària dins de 24 hores.
rectifies_uuidUUID rectificat o null en una emissió inicial.
La mateixa metadata de la petició; null si no s'ha proporcionat.
document_localeIdioma del PDF escollit en emetre'l segons l'organització. Es conserva al resultat; canviar l'idioma de l'organització no modifica documents existents. No canvia camps JSON ni missatges d'error de l'API.
Consultar estat
Retorna únicament l'estat d'un document de la credencial autenticada, durant les 24 hores següents a la creació. Un document eliminat respon 200 amb {"status":"deleted"}; no retorna dades del transport, PDF, enllaç QR ni metadata. Un document actiu respon amb {"status":"active"}.
Un UUID inexistent, d'una altra credencial o fora de les 24 hores retorna el mateix 404. L'eliminació no amplia aquesta finestra.
Paràmetres de ruta
uuidUUID públic del document. Alternativament, utilitza GET /api/v1/documents/ref/{reference}/status. Exemple: /api/v1/documents/ref/EXP-2026-004587/status.
Consultar estat › Respostes
Estat del document sense dades del contingut.
statusEstat del document. No inclou informació del transport, PDF, QR, metadata ni dates.
Descarregar PDF
Retorna exactament els bytes del PDF emmagatzemat, sense regenerar-lo. Exigeix la credencial propietària i una antiguitat inferior a 24 hores. Aquesta limitació no altera la conservació legal ni la vigència del QR.
Un document eliminat retorna 404 sense lliurar el PDF.
Paràmetres de ruta
uuidUUID públic del document. Alternativament, utilitza GET /api/v1/documents/ref/{reference}/pdf. Exemple: /api/v1/documents/ref/EXP-2026-004587/pdf.
Descarregar PDF › Respostes
PDF original natiu, de fins a 5 MB. Descàrrega directa sense regeneració.