Dokumentuak

Norberaren azken dokumentuak jaulkitzea, zuzentzea eta atzitzea.

Sortu dokumentua

POST

https://deca.sertecpesage.com

/api/v1/documents

Bearer

Bidali garraioaren datu guztiak. PDF zifratua sortu eta gorde ondoren itzultzen da erantzuna.

Null ez den erreferentzia bakarra da erakunde eta ingurune bakoitzeko. Erreferentzia bera datu normalizatu eta metadata berberekin berriz bidaltzeak jatorrizko emaitza itzultzen du 24 orduko epean (200), beste PDFrik jaulki gabe. Sorrera berri batek 201 itzultzen du. Datu desberdinek edo beste kredentzial baten erreferentziak 409 eragiten dute, dokumentuak zabaldu gabe. Erreferentziarik gabe ez da bikoiztuen ezabaketa bermatzen.

Emaitza iraungita duen erreferentziak 409 DOCUMENT_WINDOW_EXPIRED itzultzen du. Dokumentua ezabatuta badago, ez da edukia itzultzen eta ezin da erreferentzia berrerabili; berriz saiatzeak 404 itzultzen du. Zuzentzeko, erabili PUT endpointak.

sk_demo_ token bat eska dezakezu konturik edo erakunderik erregistratu gabe. Jaulkitzen denetik 24 ordu irauten du eta eskatu duen IP publikotik bakarrik funtzionatzen du. Sarea edo IPa aldatuz gero, beste token bat eskatu behar da. Demoak demo: true, expires_at, qr_url (url eremuaren aliasa) eta pdf_url (pdf_download_url eremuaren aliasa) gehitzen ditu. document_locale tokena eskatzean aukeratutako hizkuntza da (es lehenespenez). Aldi baterako datuak eta PDFak benetako artxibotik bereizita daude eta ez dira benetako dokumentuak bezala zifratzen.

Sortu dokumentua › Eskaeraren gorputza

CreateDocumentRequest

transport_date

string · date · nahitaezkoa

Benetako garraio-data YYYY-MM-DD formatuan; ez da PDFaren sorrera-unea.

Probarako balioa

Shipper · nahitaezkoa

Kontratuzko kargatzailea; jatorriko biltegitik eta DeCA bezeroarengandik desberdina izan daiteke.

Carrier · nahitaezkoa

Garraioa benetan egiten duen garraiolaria, azpikontratatua barne.

TransportLocation · nahitaezkoa

Goods · nahitaezkoa

Salgaien izaera eta pisua, edo ordezko magnitudea dagokionean. Bidali neurri bakarra.

Vehicle · nahitaezkoa

Benetako ibilgailua; atoia edo erdiatoia badago, bete haren bi eremuak batera.

reference

string | null · minLength: 1 · maxLength: 120 · pattern: ^[A-Za-z0-9-]+(?![\s…

Norberaren aukerako erreferentzia, erakunde eta ingurune bakoitzeko bakarra eta PDFan inprimatua. Berriz saiatzeak identifikatzen ditu eta erreferentzia bidez kontsultatzeko aukera ematen du. Ez da askatzen dokumentua ezabatzean.

Probarako balioa

SpecialAuthorization

Zirkulazio-baimen berezia beharrezkoa denean. Ez bidali edo bidali null ez badagokio.

Probarako balioa

observations

string | null · maxLength: 4000

Parte-hartzaileek dokumentuan jasotzeko eskatzen dituzten oharrak.

Probarako balioa

object | null

Aukerako JSON objektua, aldaketa semantikorik gabe gorde eta itzultzen dena. Ez da PDFan inprimatzen. Gehienez 16 KiB serializatzean eta 8 sakonera-maila.

Probarako balioa

Sortu dokumentua › Erantzunak

Berriz saiatze idempotentea; jatorrizko emaitza itzultzen du beste PDFrik sortu gabe.

oneOf

Aukera bakarra bete behar da.

Aukeren taula

Aukera	Hautaketa-irizpideak
	type = object · Nahitaezko eremuak: uuid, reference, created_at +beste 7
	type = object · Nahitaezko eremuak: uuid, reference, created_at +beste 11

Aukera 1 aukeraren propietateak:

DocumentResult

uuid

string · uuid · nahitaezkoa

Jaulkitako dokumentuaren UUIDa.

reference

string | null · pattern: ^[A-Za-z0-9-]+(?![\s… · nahitaezkoa

Bezeroaren erreferentzia edo null.

created_at

string · date-time · nahitaezkoa

Jatorrizko sorrera-unea, UTCn.

url

string · uri · nahitaezkoa

QR bidez deskargatzeko HTTPS URL osoa, sekretua barne. Ez erregistratu edo argitaratu.

object · nahitaezkoa

pdf_download_url

string · uri · nahitaezkoa

Deskarga autentifikatuaren URLa; kredentzial jabearen Bearerra behar du 24 orduko epean.

rectifies_uuid

string | null · uuid · nahitaezkoa

Zuzendutako UUIDa edo null hasierako jaulkipenean.

CreateDocumentRequest · nahitaezkoa

object | null · nahitaezkoa

Eskaeraren metadata bera; null eman ez bada.

document_locale

string · enum · nahitaezkoa

Jaulkitzean erakundearen arabera hautatutako PDFaren hizkuntza. Emaitzan gordetzen da; erakundearen hizkuntza aldatzeak ez ditu lehendik dauden dokumentuak aldatzen. Ez ditu JSON eremuak edo APIaren errore-mezuak aldatzen.

Onartutako balioak:

ca-valencia

pt-pt

POST/api/v1/documents

curl https://deca.sertecpesage.com/api/v1/documents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "reference": "EXP-2026-004587",
  "transport_date": "2026-10-05",
  "shipper": {
    "name": "Distribuciones Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B12345674",
    "address": {
      "street": "Carrer de la Logística, 18",
      "postal_code": "08040",
      "city": "Barcelona",
      "country": "ES"
    }
  },
  "carrier": {
    "name": "Transportes Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B87654323"
  },
  "origin": {
    "place": "Almacén Barcelona",
    "city": "Barcelona",
    "country": "ES"
  },
  "destination": {
    "place": "Almacén Zaragoza",
    "city": "Zaragoza",
    "country": "ES"
  },
  "goods": {
    "description": "Vino embotellado",
    "weight_kg": "1850.000"
  },
  "vehicle": {
    "country": "ES",
    "registration": "4827 MNL",
    "trailer_country": "ES",
    "trailer_registration": "R 5832 BCD"
  },
  "special_authorization": null,
  "observations": null,
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  }
}'

Eskaera-gorputzaren adibidea

{
  "reference": "EXP-2026-004587",
  "transport_date": "2026-10-05",
  "shipper": {
    "name": "Distribuciones Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B12345674",
    "address": {
      "street": "Carrer de la Logística, 18",
      "postal_code": "08040",
      "city": "Barcelona",
      "country": "ES"
    }
  },
  "carrier": {
    "name": "Transportes Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B87654323"
  },
  "origin": {
    "place": "Almacén Barcelona",
    "city": "Barcelona",
    "country": "ES"
  },
  "destination": {
    "place": "Almacén Zaragoza",
    "city": "Zaragoza",
    "country": "ES"
  },
  "goods": {
    "description": "Vino embotellado",
    "weight_kg": "1850.000"
  },
  "vehicle": {
    "country": "ES",
    "registration": "4827 MNL",
    "trailer_country": "ES",
    "trailer_registration": "R 5832 BCD"
  },
  "special_authorization": null,
  "observations": null,
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  }
}

json

application/json

Erantzunen adibideak

{
  "uuid": "75b10a04-1a2d-4f9e-9277-5f3c270f476e",
  "reference": "EXP-2026-004587",
  "created_at": "2026-10-05T14:43:00Z",
  "url": "https://deca.sertecpesage.com/d/75b10a04-1a2d-4f9e-9277-5f3c270f476e?k=EXAMPLE_SECRET",
  "qr": {
    "mime_type": "image/png",
    "encoding": "base64",
    "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+jRZkAAAAASUVORK5CYII="
  },
  "pdf_download_url": "https://deca.sertecpesage.com/api/v1/documents/75b10a04-1a2d-4f9e-9277-5f3c270f476e/pdf",
  "rectifies_uuid": null,
  "normalized_data": {
    "reference": "EXP-2026-004587",
    "transport_date": "2026-10-05",
    "shipper": {
      "name": "Distribuciones Demo, S. L.",
      "tax_country": "ES",
      "tax_id": "B12345674",
      "address": {
        "street": "Carrer de la Logística, 18",
        "postal_code": "08040",
        "city": "Barcelona",
        "country": "ES"
      }
    },
    "carrier": {
      "name": "Transportes Demo, S. L.",
      "tax_country": "ES",
      "tax_id": "B87654323"
    },
    "origin": {
      "place": "Almacén Barcelona",
      "city": "Barcelona",
      "country": "ES"
    },
    "destination": {
      "place": "Almacén Zaragoza",
      "city": "Zaragoza",
      "country": "ES"
    },
    "goods": {
      "description": "Vino embotellado",
      "weight_kg": "1850"
    },
    "vehicle": {
      "country": "ES",
      "registration": "4827MNL",
      "trailer_country": "ES",
      "trailer_registration": "R5832BCD"
    },
    "special_authorization": null,
    "observations": null,
    "metadata": {
      "order_id": "4587",
      "terminal": "POS-02"
    }
  },
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  },
  "document_locale": "es"
}

json

application/json

Zuzendu dokumentua

PUT

https://deca.sertecpesage.com

/api/v1/documents/{uuid}

Bearer

Identifikatu aurreko dokumentua UUID bidez eta bidali zuzendutako datu guztiak, aldaketa partzialik gabe. Kredentzial beraren azken bertsioa soilik zuzendu daiteke. 24 ordu baino gehiago duen dokumentua zuzendu daiteke aurreko edukia itzuli gabe. Ezabatutako dokumentuak 404 itzultzen du eta ezin da zuzendu.

Dokumentu zuzentzailea sortzen da UUID, PDF eta QR berriekin; jatorrizkoa eta haren QRa gordetzen dira. Eman PDF berria gidariari. Gorputzeko reference eremua bertsio berriari dagokio, ez URLko dokumentuari.

PUT bera datu normalizatu eta metadata berberekin errepikatzeak dagoeneko jaulkitako zuzenketa itzultzen du sortu ondorengo 24 orduetan, beste bertsiorik sortu gabe. Egiaztapen hori dagoeneko zuzendutako dokumentua baztertu aurretik egiten da, eta berriz saiatzeak dokumentu bera erreferentzia bidez identifikatzen badu ere funtzionatzen du. Zuzendutako dokumentu baten datuak aldatzeak 409 itzultzen du. Iraungitako emaitzak 409 DOCUMENT_WINDOW_EXPIRED itzultzen du. Itzulitako zuzenketa ezabatuta badago, berriz saiatzeak 404 itzultzen du. Beste zuzenketa baterako, erabili azken bertsioaren UUIDa edo erreferentzia.

Zuzendu dokumentua › Bide-parametroak

uuid

string · uuid · nahitaezkoa

Dokumentuaren UUID publikoa. Bestela, erabili /api/v1/documents/ref/{reference} metodo berarekin. Adibidea: /api/v1/documents/ref/EXP-2026-004587.

Probarako balioa

Zuzendu dokumentua › Eskaeraren gorputza

Garraioaren zuzendutako datu guztiak. Aurreko dokumentua URLan identifikatzen da. reference sartzen bada, dokumentu zuzentzailearen erreferentzia berria izan behar du.

RectifyDocumentRequest

transport_date

string · date · nahitaezkoa

Benetako garraio-data YYYY-MM-DD formatuan; ez da PDFaren sorrera-unea.

Probarako balioa

Shipper · nahitaezkoa

Kontratuzko kargatzailea; jatorriko biltegitik eta DeCA bezeroarengandik desberdina izan daiteke.

Carrier · nahitaezkoa

Garraioa benetan egiten duen garraiolaria, azpikontratatua barne.

TransportLocation · nahitaezkoa

Goods · nahitaezkoa

Salgaien izaera eta pisua, edo ordezko magnitudea dagokionean. Bidali neurri bakarra.

Vehicle · nahitaezkoa

Benetako ibilgailua; atoia edo erdiatoia badago, bete haren bi eremuak batera.

reference

string | null · minLength: 1 · maxLength: 120 · pattern: ^[A-Za-z0-9-]+(?![\s…

Dokumentu zuzentzailearen erreferentzia berria, aukerakoa eta erakunde eta ingurune bakoitzeko bakarra. Ez berrerabili URLan identifikatutako dokumentuaren erreferentzia.

Probarako balioa

SpecialAuthorization

Zirkulazio-baimen berezia beharrezkoa denean. Ez bidali edo bidali null ez badagokio.

Probarako balioa

observations

string | null · maxLength: 4000

Parte-hartzaileek dokumentuan jasotzeko eskatzen dituzten oharrak.

Probarako balioa

object | null

Aukerako JSON objektua, aldaketa semantikorik gabe gorde eta itzultzen dena. Ez da PDFan inprimatzen. Gehienez 16 KiB serializatzean eta 8 sakonera-maila.

Probarako balioa

Zuzendu dokumentua › Erantzunak

Dokumentu zuzentzailea jaulki da, edo berriz saiatze berdinaren emaitza itzuli da beste bertsiorik sortu gabe.

oneOf

Aukera bakarra bete behar da.

Aukeren taula

Aukera	Hautaketa-irizpideak
	type = object · Nahitaezko eremuak: uuid, reference, created_at +beste 7
	type = object · Nahitaezko eremuak: uuid, reference, created_at +beste 11

Aukera 1 aukeraren propietateak:

DocumentResult

uuid

string · uuid · nahitaezkoa

Jaulkitako dokumentuaren UUIDa.

reference

string | null · pattern: ^[A-Za-z0-9-]+(?![\s… · nahitaezkoa

Bezeroaren erreferentzia edo null.

created_at

string · date-time · nahitaezkoa

Jatorrizko sorrera-unea, UTCn.

url

string · uri · nahitaezkoa

QR bidez deskargatzeko HTTPS URL osoa, sekretua barne. Ez erregistratu edo argitaratu.

object · nahitaezkoa

pdf_download_url

string · uri · nahitaezkoa

Deskarga autentifikatuaren URLa; kredentzial jabearen Bearerra behar du 24 orduko epean.

rectifies_uuid

string | null · uuid · nahitaezkoa

Zuzendutako UUIDa edo null hasierako jaulkipenean.

CreateDocumentRequest · nahitaezkoa

object | null · nahitaezkoa

Eskaeraren metadata bera; null eman ez bada.

document_locale

string · enum · nahitaezkoa

Onartutako balioak:

ca-valencia

pt-pt

PUT/api/v1/documents/{uuid}

curl https://deca.sertecpesage.com/api/v1/documents/:uuid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "reference": "EXP-2026-004587-R1",
  "transport_date": "2026-10-05",
  "shipper": {
    "name": "Distribuciones Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B12345674",
    "address": {
      "street": "Carrer de la Logística, 18",
      "postal_code": "08040",
      "city": "Barcelona",
      "country": "ES"
    }
  },
  "carrier": {
    "name": "Transportes Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B87654323"
  },
  "origin": {
    "place": "Almacén Barcelona",
    "city": "Barcelona",
    "country": "ES"
  },
  "destination": {
    "place": "Almacén Zaragoza",
    "city": "Zaragoza",
    "country": "ES"
  },
  "goods": {
    "description": "Vino embotellado",
    "weight_kg": "1900.000"
  },
  "vehicle": {
    "country": "ES",
    "registration": "4827 MNL",
    "trailer_country": "ES",
    "trailer_registration": "R 5832 BCD"
  },
  "special_authorization": null,
  "observations": "Corrección del peso de la mercancía.",
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  }
}'

Eskaera-gorputzaren adibidea

{
  "reference": "EXP-2026-004587-R1",
  "transport_date": "2026-10-05",
  "shipper": {
    "name": "Distribuciones Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B12345674",
    "address": {
      "street": "Carrer de la Logística, 18",
      "postal_code": "08040",
      "city": "Barcelona",
      "country": "ES"
    }
  },
  "carrier": {
    "name": "Transportes Demo, S. L.",
    "tax_country": "ES",
    "tax_id": "B87654323"
  },
  "origin": {
    "place": "Almacén Barcelona",
    "city": "Barcelona",
    "country": "ES"
  },
  "destination": {
    "place": "Almacén Zaragoza",
    "city": "Zaragoza",
    "country": "ES"
  },
  "goods": {
    "description": "Vino embotellado",
    "weight_kg": "1900.000"
  },
  "vehicle": {
    "country": "ES",
    "registration": "4827 MNL",
    "trailer_country": "ES",
    "trailer_registration": "R 5832 BCD"
  },
  "special_authorization": null,
  "observations": "Corrección del peso de la mercancía.",
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  }
}

json

application/json

Erantzunen adibideak

{
  "uuid": "dbf53b0c-e0ec-49a4-952d-ed59d9b1b0d1",
  "reference": "EXP-2026-004587-R1",
  "created_at": "2026-10-05T15:00:00Z",
  "url": "https://deca.sertecpesage.com/d/dbf53b0c-e0ec-49a4-952d-ed59d9b1b0d1?k=EXAMPLE_RECTIFICATION_SECRET",
  "qr": {
    "mime_type": "image/png",
    "encoding": "base64",
    "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+jRZkAAAAASUVORK5CYII="
  },
  "pdf_download_url": "https://deca.sertecpesage.com/api/v1/documents/dbf53b0c-e0ec-49a4-952d-ed59d9b1b0d1/pdf",
  "rectifies_uuid": "75b10a04-1a2d-4f9e-9277-5f3c270f476e",
  "normalized_data": {
    "reference": "EXP-2026-004587-R1",
    "transport_date": "2026-10-05",
    "shipper": {
      "name": "Distribuciones Demo, S. L.",
      "tax_country": "ES",
      "tax_id": "B12345674",
      "address": {
        "street": "Carrer de la Logística, 18",
        "postal_code": "08040",
        "city": "Barcelona",
        "country": "ES"
      }
    },
    "carrier": {
      "name": "Transportes Demo, S. L.",
      "tax_country": "ES",
      "tax_id": "B87654323"
    },
    "origin": {
      "place": "Almacén Barcelona",
      "city": "Barcelona",
      "country": "ES"
    },
    "destination": {
      "place": "Almacén Zaragoza",
      "city": "Zaragoza",
      "country": "ES"
    },
    "goods": {
      "description": "Vino embotellado",
      "weight_kg": "1900"
    },
    "vehicle": {
      "country": "ES",
      "registration": "4827MNL",
      "trailer_country": "ES",
      "trailer_registration": "R5832BCD"
    },
    "special_authorization": null,
    "observations": "Corrección del peso de la mercancía.",
    "metadata": {
      "order_id": "4587",
      "terminal": "POS-02"
    }
  },
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  },
  "document_locale": "es"
}

json

application/json

Ezabatu dokumentua

DELETE

https://deca.sertecpesage.com

/api/v1/documents/{uuid}

Bearer

Dokumentua sortzean aurkitutako akatsak zuzentzeko ezabatze logikoa, soilik garraiolariari edo gidariari entregatu aurretik eta garraio batean erabili aurretik. Integrazioak bi baldintzak baieztatu behar ditu; epearen barruan egotea ez da nahikoa. Dokumentua entregatu edo erabili bada, PUT bidez zuzendu behar da.

Zerbitzariaren ordua created_at + 2 ordu baino lehenagokoa den bitartean soilik onartzen da; 2 ordu zehatzetan ez da onartzen. Kontsultek eta berriz saiatzeek ez dute epea berrabiarazten. Bertsio bakoitzak bere sorrera-data erabiltzen du. Autentifikatutako kredentzialaren azken bertsioa soilik ezabatu daiteke.

PDFa, datuak eta trazabilitatea gordetzen dira, baina dokumentua zerrendatik desagertzen da. UUID edo erreferentzia bidezko kontsultek, deskarga autentifikatuak, QRak eta edukia itzuliko luketen berriz saiatzeek 404 erantzuten dute. Egoera-kontsultak status: deleted soilik itzultzen du 24 orduko kontsulta-epean. Erreferentzia erreserbatuta geratzen da. Ez dago berraktibatzeko endpointik; fitxategia gordetzen da etorkizunean berreskuratu ahal izateko.

DELETE 2 ordu berberen barruan errepikatzeak 204 itzultzen du ezabatze-data aldatu gabe. Epea igarota, 409 itzultzen du.

QR estekaren bidezko lehen sarbide zuzenak ere ezabatzea blokeatzen du 409 DOCUMENT_ALREADY_ACCESSED errorearekin. Sarbide horrek, berez, ez du garraioa egin dela frogatzen.

Ezabatu dokumentua › Bide-parametroak

uuid

string · uuid · nahitaezkoa

Dokumentuaren UUID publikoa. Bestela, erabili /api/v1/documents/ref/{reference} metodo berarekin. Adibidea: /api/v1/documents/ref/EXP-2026-004587.

Probarako balioa

Ezabatu dokumentua › Eskaeraren gorputza

DeleteDocumentRequest

reason

string · minLength: 1 · maxLength: 2000 · nahitaezkoa

Dokumentua sortzean detektatutako akatsaren arrazoia.

Probarako balioa

confirm_not_delivered

boolean · nahitaezkoa

Ezabatzeko true izan behar du: garraiolariari edo gidariari entregatu ez zaiola baieztatzen du. false balioak 409 DOCUMENT_ALREADY_DELIVERED itzultzen du.

Probarako balioa

confirm_not_used

boolean · nahitaezkoa

Ezabatzeko true izan behar du: garraio batean erabili ez dela baieztatzen du. false balioak 409 DOCUMENT_ALREADY_USED itzultzen du.

Probarako balioa

Ezabatu dokumentua › Erantzunak

Dokumentua ezabatutzat markatu da. Erantzun-gorputzik gabe.

Ez da daturik itzultzen

Zerrendatu azken dokumentuak

GET

https://deca.sertecpesage.com

/api/v1/documents

Bearer

Laburpenak itzultzen ditu, PDFrik, QR sekreturik eta metadatarik gabe. Zerbitzariak beti aplikatzen ditu 24 orduko epea eta kredentzialen isolamendua. Sorrera-dataren arabera beherantz ordenatzen da, eta berdinketak UUIDarekin ebazten dira; orrialdekako paginazioa eta garraio-dataren iragazki inklusiboak erabiltzen dira. Epea eskaera bakoitzean ebaluatzen da; ez da orrialdeen arteko argazki egonkorra. Ez du historia kontsultatzeko aukerarik ematen.

Ezabatutako dokumentuak ez dira zerrendan agertzen.

Zerrendatu azken dokumentuak › Kontsulta-parametroak

page

integer · min: 1

Eskatutako orrialdea, 1etik hasita.

Balio lehenetsia: 1

Probarako balioa

limit

integer · min: 1 · max: 100

Dokumentuak orrialdeko, 1etik 100era.

Balio lehenetsia: 25

Probarako balioa

from

string · date

Garraio-data txikiena, barne. Ez du irakurketa-epea luzatzen.

Probarako balioa

to

string · date

Garraio-data handiena, barne; from egun berekoa edo ondorengoa.

Probarako balioa

Zerrendatu azken dokumentuak › Erantzunak

Azken dokumentuen orrialdea. Emaitzarik gabeko orrialdeak data hutsik du.

DocumentList

DocumentSummary[] · nahitaezkoa

object · nahitaezkoa

Kontsultatu dokumentua

GET

https://deca.sertecpesage.com

/api/v1/documents/{uuid}

Bearer

Jatorrizko emaitza berreskuratzen du 24 orduko epean, dokumentua jaulki zuen kredentzialarentzat soilik. Onartutako eta normalizatutako eremu guztiak eta aldaketa semantikorik gabeko metadata biltzen ditu.

Existitzen ez den, beste kredentzial bati dagokion edo epetik kanpoko UUID edo erreferentzia batek 404 bera itzultzen du, existentzia edo jabea baieztatu gabe. Erreferentzia bakoitzak bere bertsioa identifikatzen du eta ez du ondorengo zuzenketa batera birbideratzen.

Ezabatutako dokumentuak 404 itzultzen du. Ezabatuta dagoen jakiteko, erabili egoera-kontsulta.

Kontsultatu dokumentua › Bide-parametroak

uuid

string · uuid · nahitaezkoa

Dokumentuaren UUID publikoa. Bestela, erabili /api/v1/documents/ref/{reference} metodo berarekin. Adibidea: /api/v1/documents/ref/EXP-2026-004587.

Probarako balioa

Kontsultatu dokumentua › Erantzunak

Dokumentuaren jatorrizko emaitza.

oneOf

Aukera bakarra bete behar da.

Aukeren taula

Aukera	Hautaketa-irizpideak
	type = object · Nahitaezko eremuak: uuid, reference, created_at +beste 7
	type = object · Nahitaezko eremuak: uuid, reference, created_at +beste 11

Aukera 1 aukeraren propietateak:

DocumentResult

uuid

string · uuid · nahitaezkoa

Jaulkitako dokumentuaren UUIDa.

reference

string | null · pattern: ^[A-Za-z0-9-]+(?![\s… · nahitaezkoa

Bezeroaren erreferentzia edo null.

created_at

string · date-time · nahitaezkoa

Jatorrizko sorrera-unea, UTCn.

url

string · uri · nahitaezkoa

QR bidez deskargatzeko HTTPS URL osoa, sekretua barne. Ez erregistratu edo argitaratu.

object · nahitaezkoa

pdf_download_url

string · uri · nahitaezkoa

Deskarga autentifikatuaren URLa; kredentzial jabearen Bearerra behar du 24 orduko epean.

rectifies_uuid

string | null · uuid · nahitaezkoa

Zuzendutako UUIDa edo null hasierako jaulkipenean.

CreateDocumentRequest · nahitaezkoa

object | null · nahitaezkoa

Eskaeraren metadata bera; null eman ez bada.

document_locale

string · enum · nahitaezkoa

Onartutako balioak:

ca-valencia

pt-pt

GET/api/v1/documents/{uuid}

curl https://deca.sertecpesage.com/api/v1/documents/:uuid \
  --header 'Authorization: Bearer <token>'

Erantzunen adibideak

{
  "uuid": "75b10a04-1a2d-4f9e-9277-5f3c270f476e",
  "reference": "EXP-2026-004587",
  "created_at": "2026-10-05T14:43:00Z",
  "url": "https://deca.sertecpesage.com/d/75b10a04-1a2d-4f9e-9277-5f3c270f476e?k=EXAMPLE_SECRET",
  "qr": {
    "mime_type": "image/png",
    "encoding": "base64",
    "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+jRZkAAAAASUVORK5CYII="
  },
  "pdf_download_url": "https://deca.sertecpesage.com/api/v1/documents/75b10a04-1a2d-4f9e-9277-5f3c270f476e/pdf",
  "rectifies_uuid": null,
  "normalized_data": {
    "reference": "EXP-2026-004587",
    "transport_date": "2026-10-05",
    "shipper": {
      "name": "Distribuciones Demo, S. L.",
      "tax_country": "ES",
      "tax_id": "B12345674",
      "address": {
        "street": "Carrer de la Logística, 18",
        "postal_code": "08040",
        "city": "Barcelona",
        "country": "ES"
      }
    },
    "carrier": {
      "name": "Transportes Demo, S. L.",
      "tax_country": "ES",
      "tax_id": "B87654323"
    },
    "origin": {
      "place": "Almacén Barcelona",
      "city": "Barcelona",
      "country": "ES"
    },
    "destination": {
      "place": "Almacén Zaragoza",
      "city": "Zaragoza",
      "country": "ES"
    },
    "goods": {
      "description": "Vino embotellado",
      "weight_kg": "1850"
    },
    "vehicle": {
      "country": "ES",
      "registration": "4827MNL",
      "trailer_country": "ES",
      "trailer_registration": "R5832BCD"
    },
    "special_authorization": null,
    "observations": null,
    "metadata": {
      "order_id": "4587",
      "terminal": "POS-02"
    }
  },
  "metadata": {
    "order_id": "4587",
    "terminal": "POS-02"
  },
  "document_locale": "es"
}

json

application/json

Kontsultatu egoera

GET

https://deca.sertecpesage.com

/api/v1/documents/{uuid}/status

Bearer

Autentifikatutako kredentzialaren dokumentu baten egoera soilik itzultzen du, sortu ondorengo 24 orduetan. Ezabatutako dokumentuak 200 erantzuten du {"status":"deleted"} balioarekin; ez du garraio-daturik, PDFrik, QR estekarik edo metadatarik itzultzen. Dokumentu aktiboak {"status":"active"} erantzuten du.

Existitzen ez den, beste kredentzial bati dagokion edo 24 orduko epetik kanpoko UUID batek 404 bera itzultzen du. Ezabatzeak ez du epea luzatzen.

Kontsultatu egoera › Bide-parametroak

uuid

string · uuid · nahitaezkoa

Dokumentuaren UUID publikoa. Bestela, erabili GET /api/v1/documents/ref/{reference}/status. Adibidea: /api/v1/documents/ref/EXP-2026-004587/status.

Probarako balioa

Kontsultatu egoera › Erantzunak

Dokumentuaren egoera, edukiko daturik gabe.

DocumentStatus

status

string · enum · nahitaezkoa

Dokumentuaren egoera. Ez du garraio-informaziorik, PDFrik, QRrik, metadatarik edo datarik.

Onartutako balioak:

active

deleted

Deskargatu PDFa

GET

https://deca.sertecpesage.com

/api/v1/documents/{uuid}/pdf

Bearer

Gordetako PDFaren byte zehatzak itzultzen ditu, berriz sortu gabe. Kredentzial jabea eta 24 ordu baino gutxiagoko dokumentua behar dira. Muga horrek ez du legezko kontserbazioa edo QRaren iraunaldia aldatzen.

Ezabatutako dokumentuak 404 itzultzen du PDFa entregatu gabe.

Deskargatu PDFa › Bide-parametroak

uuid

string · uuid · nahitaezkoa

Dokumentuaren UUID publikoa. Bestela, erabili GET /api/v1/documents/ref/{reference}/pdf. Adibidea: /api/v1/documents/ref/EXP-2026-004587/pdf.

Probarako balioa

Deskargatu PDFa › Erantzunak

Jatorrizko PDF natiboa, gehienez 5 MB. Deskarga zuzena, berriz sortu gabe.

string

QR bidezko deskarga