Ga naar hoofdinhoud
Versie: Next (1.6.0) 🛠️
Version: 1.5.0

Documenten API

Een API om een documentregistratiecomponent (DRC) te benaderen.

In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten worden gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben.

GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het INFORMATIEOBJECT (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd of gehandhaafd.

De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in de vorm van INFORMATIEOBJECTTYPEn.

Uploaden van bestanden

Binnen deze API bestaan een aantal endpoints die binaire data ontvangen, al dan niet base64-encoded. Webservers moeten op deze endpoints een minimale request body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de metadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de overhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit betekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot mag zijn.

Nieuw in 1.5.0

  1. Het optionele attribuut "inhoudIsVervallen" is toegevoegd aan de resource enkelvoudiginformatieobjecten.
  2. De voorwaarde "status NIET definitief" is verwijderd uit de beschrijvingen van de PUT- en PATCH-operatie op enkelvoudiginformatieobjecten. Dit is een correctie van een fout in de OAS, want deze voorwaarde was al geschrapt in de aanvullende specificatie van versie 1.4.0.

Nieuw in 1.1.0

Bestanden kunnen groter zijn dan de minimale die door providers ondersteund moet worden. De consumer moet dan:

  1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale bestandsgrootte meegestuurd wordt en de inhoud leeggelaten wordt. De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT.
  2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben zoals dit aangegeven werd in de response bij 1.
  3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige BESTANDSDEEL-url gestuurd worden, samen met het lock ID.
  4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat alle bestandsdelen correct opgestuurd werden, en voegt deze samen tot het resulterende bestand.

Het bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop.

De 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden die niet gesplitst hoeven te worden.

Afhankelijkheden

Deze API is afhankelijk van:

  • Catalogi API
  • Notificaties API
  • Autorisaties API (optioneel)
  • Zaken API (optioneel)

Autorisatie

Deze API vereist autorisatie. Je kan de token-tool gebruiken om JWT-tokens te genereren.

Notificaties​

Deze API publiceert notificaties op het kanaal documenten.

Main resource

enkelvoudiginformatieobject

Kenmerken

  • bronorganisatie: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd.
  • informatieobjecttype: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API).
  • vertrouwelijkheidaanduiding: Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is.

Resources en acties

Handige links

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT