Interface & API

Kan een IT-afdeling of IT-leverancier met de instructies in deze documentatie zelfstandig de koppeling maken tussen de Digitaal Logboek API en de API van het eigen (ERP)systeem?

De documentatie omgeving is zo opgezet dat deze zowel contextuele als technische informatie verschaft en daarnaast voorziet in een mogelijkheid om de API in test- en productieomgeving live te testen. We zijn er dan ook van overtuigd dat een (externe) IT-afdeling of -leverancier met deze documentatie uit de voeten kan om de API koppeling te maken. Uiteraard staan we open voor advies, eventuele verbeteringen en/of suggesties. Stuur daarvoor een e-mail naar [email protected].

Bestaat de kans dat nieuwe ontwikkelingen aan het Digitaal Logboek invloed hebben op een al gemaakte koppeling met de API?

Ontwikkelingen aan de API worden zo uitgevoerd dat er in principe geen wijzigingen zullen plaatsvinden voor bestaande koppelingen. Nieuwe functionaliteit wordt zo goed als mogelijk aangevuld op de huidige werking en kunnen worden toegevoegd aan een bestaande koppeling (niet verplicht). Hoewel dit het streven is, kan het voorkomen dat noodzakelijke wijzigingen moeten worden doorgevoerd in de toekomst die eventueel effect hebben op bestaande koppelingen. Bijvoorbeeld in het geval van (noodzakelijke) optimalisaties rondom databeveiliging of -uitwisseling. In zo’n geval zal de wijziging tijdig kenbaar worden gemaakt via de bekende kanalen, zodat hierop kan worden geanticipeerd.

Is het mogelijk bulk acties uit te voeren via de API?

Nee, dat is niet mogelijk. Per call (aanroeping Digitaal Logboek) kan maximaal 1 installatie of log worden aangemaakt, bewerkt of verwijderd. Uiteraard is het mogelijk om meerdere calls achter elkaar uit te voeren, zodat data in bulk kan worden opgehaald, bijgewerkt of aangemaakt.

Kan het invoeren van logs gebeuren via de web-interface op locatie of vindt dit achteraf plaats?

Het invoeren van gegevens kan alleen plaatsvinden via de API en is niet mogelijk via de web-interface. Het moment waarop installatiegegevens of een log worden toegevoegd is afhankelijk van de eigen bedrijfslogica. Idealiter wordt deze data vastgelegd in het eigen systeem (monteur met fieldterminal) waarna de data vanuit het eigen systeem automatisch wordt verstuurd naar de Digitaal Logboek API.

Zullen de zoekmogelijkheden worden uitgebreid?

De zoekmogelijkheden zullen vooralsnog niet worden uitgebreid, omwille van bescherming van de data in het Digitaal Logboek. Een installatie kan gevonden worden door een combinatie van de postcode en een fabrikantcode (installationId) of aangepaste code (customId), of met het SBCL-ID.

Kunnen partijen zonder API-aansluiting via de web-interface wijzigingen aanbrengen?

Op dit moment zijn wijzigingen via de web-interface (nog) niet mogelijk. Als men niet over een API aansluiting beschikt, kunnen er geen installaties of logs worden aangemaakt.

Hoe kan een kleine(re) onderhoudspartij zonder API nu data loggen?

Het schrijven van data is op dit moment alleen mogelijk via de Digitaal Logboek API. Voor partijen die (nog) niet beschikken over een API is het op dit moment dus niet mogelijk om installaties of logs toe te voegen. De bouw van een softwareoplossing of API welke data kan ophalen en schrijven naar het Digitaal Logboek hoeft geen significante investering te zijn, echter e.e.a. is afhankelijk van bedrijfsfactoren en ontwikkeleisen. Tevens is er vanuit SBCL subsidie beschikbaar voor de ontwikkeling van een API, zie Algemeen.