Aan de slag

Algemeen

Registreer een account via https://logboek.sbcl.nl/register.
Bij goedkeuring vanuit SBCL ontvangt u per e-mail aparte API-keys voor toegang tot de API's van de test- en productieomgeving.
Configureer de koppeling met het Digitaal Logboek, initieel met de testomgeving. Als het uitwisselen van informatie succesvol is verlopen realiseert u de aansluiting met de productie omgeving.

Nieuwe gegevens invoeren

Als onderhoudsfirma kunt u installaties aanmaken¹ en bewerken². De uitgegeven API-key is gekoppeld aan de rol die dit mogelijk maakt.

Maak een nieuwe installatie aan (via https://logboek-api.sbcl.nl/docs/#/Installation/post_installations)
a. Gebruik een geldige Manufacturer ID (bijvoorbeeld via https://logboek-api.sbcl.nl/docs/#/Manufacturer/get_manufacturers)
Voeg een log toe aan de nieuwe installatie (bijvoorbeeld via https://logboek-api.sbcl.nl/docs/#/Log/post_installationsidlogs)

¹ Voor het aanmaken van een installatie is het noodzakelijk te beschikken over het fabrieksnummer. Dit is het nummer of de code die door de fabrikant aan de installatie is toegekend bij ingebruikname. In het Digitaal Logboek wordt dit nummer vastgelegd onder het Installatie ID (installationId).

² De organisatie die de installatie heeft aangemaakt kan stamgegevens van deze installatie aanpassen. Dit wordt gecontroleerd door de API-key van de indiener van bewerkingen te vergelijken met degene die de installatie heeft aangemaakt.

Bestaande gegevens opvragen

Zoek een bestaande installatie op (bijvoorbeeld via https://logboek-api.sbcl.nl/docs/#/Installation/get_installations__id_)
Vraag logs van de bestaande installatie op (bijvoorbeeld via https://logboek-api.sbcl.nl/docs/#/Log/get_installationsidlogs)

De technische omschrijving van alle functionaliteiten zijn te bekijken in de documentatie op https://logboek-api.sbcl.nl/docs.