Changelog KLIP-webservices
API v3
Omgeving | Endpoint | Documentatie |
---|---|---|
Bèta | ||
Productie |
Bèta 02/12/2024 - productie 17/12/2024 (gepland)
Uitbreiding API in functie van het opvragen van aanwezige KLB’s, het beheren van KLB’s en KLB-zones en het gebruik van de API door openbaardomeinbeheerders.
Nieuwe features
Het opvragen aanwezige KLB’s is nu ook mogelijk via API (opgelet: dit zijn GEEN planaanvragen, je krijgt enkel een lijst met de in de gevraagde zone aanwezige leidingbeheerders)
POST
/ws/klip/v3/maprequest/overlay
GET
/ws/klip/v3/maprequest/overlay/{MapRequestId}
Beheren van KLB-zones (zowel de gewone als deze voor transportleidingen van olie, gas, chemicaliën of elektriciteit) kan nu ook via de API. Toegevoegde calls:
POST
/ws/klip/v3/unazone/{UnaZoneId}/geometry
POST
/ws/klip/v3/unazone/{UnaZoneId}/geometry
DELETE
/ws/klip/v3/unazone/{unaZoneId}/geometry/{utilityNetworkAuthorityZoneGeometryId}
PUT
/ws/klip/v3/unazone/{UnaZoneId}/settings
DELETE
/ws/klip/v3/unazone/{unaZoneId}
POST
/ws/klip/v3/unazone/klim
Beheren van KLB op zich kan nu ook via de API.
Toegevoegde call: POST
/ws/klip/v3/una/{UnaId}
Uitgebreide bestaande calls (toevoeging Subject signing certificate): GET
/ws/klip/v3/una/{UnaId}
en GET/ws/klip/v3/una/getbyorganisation/{OrganisationId}
API nu ook beschikbaar voor openbaardomeinbeheerders. Toegevoegde calls:
GET
/ws/klip/v3/pda
GET
/ws/klip/v3/pda/{pdaZoneId}/unazones
POST
/ws/klip/v3/pda
PUT
/ws/klip/v3/pda/{pdaZoneId}
DELETE
/ws/klip/v3/pda/{pdaZoneId}
GET
/ws/klip/v3/pda/maprequests/search
GET
/ws/klip/v3/pda/maprequests/{mapRequestId}
Bèta 27/04/2023 - productie 11/06/2023
Introductie API V3 met authenticatie via Toegangsbeheer Vlaanderen te authenticeren
Nieuwe endpoints:
bèta: https://klip.api.beta-vlaanderen.be/api (was vroeger https://beta.klip.vlaanderen.be/api)
productie: https://klip.api.vlaanderen.be/api (was vroeger https://klip.vlaanderen.be/api)
Meer informatie over de nieuwe API: https://klip.api.vlaanderen.be/api/swagger/index.html
Nieuwe features
Introductie API V3 met authenticatie via Toegangsbeheer Vlaanderen te authenticeren
API-calls moeten de ID van de organisatie in kwestie bevatten
Aanpassingen in functie van de release van de Organisatiemodule
Bestaande API V2 calls blijven mogelijk via GeoSecure authenticatie tot 2024
API v2 en vroeger
v1.1.3 (bèta 16/11/2022 - productie 20/12/2022)
Opgeloste bugs
Antwoorden ‘Niet betrokken’ was niet mogelijk voor sommige KLB’s
Zowel bij ‘already responded’ als bij ‘not yet confirmed’ kwam een 405 terug van de API. Dit werd aangepast, zodat bij ‘already responded’ nu de state invalid terug gegeven wordt
v1.1.2 (bèta 07/11/2022)
Opgeloste bugs
Het was niet meer mogelijk om een IMKL-bestand via API op te laden met een dispositionType anders dan "form-data". Dit was een ongewenste breaking change voor sommige intergaties en werd opgelost.
v1.1.0 (bèta 30/08/2022)
Nieuwe features
Noodzakelijke aanpassingen in functie van de release van de functionele module IMKL
v1.0.0 (bèta 12/05/2022)
Nieuwe features
Eerste release van het IMKL-TEST gedeelte voor de nieuwe functionele module IMKL.
Versie KLIP 4.0.5 (oude KLIP) (bèta 25/3/2021 - productie 01/04/2021)
Webservices
Volgende certificaten werden vernieuwd:
de SSL certificaten waarmee KLIP de validatierapporten digitaal ondertekent
de chain certificates
Informatie nieuwe certificaten:
Bèta:
Thumbprint: 1333faa9f786eb01f78e2f72744172f097d5620f
Subject: E = aiv_security@vlaanderen.be, CN = signing.klip.vlaanderen.be/beta, OU = ITSS, O = Informatie Vlaanderen, L = Gent, S = Oost-Vlaanderen, C = BE
Vervaldatum: 12/03/2023
Download [Signing certificaat + chain certificates] (5.33 KB)
Productie:
Thumbprint: 3a494d82c383e1d5193232ad1eb5f0078cea4ace
Subject: E = aiv_security@vlaanderen.be, CN = signing.klip.vlaanderen.be/prod, OU = ITSS, O = Informatie Vlaanderen, L = Gent, S = Oost-Vlaanderen, C = BE
Vervaldatum: 12/03/2023
Download [Signing certificaat + chain certificates] (5.34 KB)
Versie 3.3.3 (beta 25/11/2019 - productie 27/11/2019)
Retry mechanisme voor REST calls naar de KLIM service is verhoogd van 2 sec naar 2 min tussen pogingen (nog steeds max. 3 pogingen).
Ook is er extra logging toegevoegd en is de KLIM response code 'MultipleWorkFlowsFound' toegevoegd.
Versie 3.2.5 (productie 12/08/2019)
IMKL 2.2 wordt niet meer gevalideerd. KLIP aanvaardt nu enkel antwoorden volgens IMKL 2.3.
Versie 3.1.0 (beta 20/11/2018)
Nieuwe features
Fusie van organisaties
Bij fusies en splitsingen van organisaties, kunnen we planaanvragen verplaatsen tussen organisaties. Hierdoor zien gebruikers zowel hun oude planaanvragen, als hun nieuwe.
Voor fusionerende KLB's kunnen KLB-zones (met bijhorende planaanvragen) verplaatst worden naar de nieuwe organisatie.
Dit kan enkel met tussenkomst van Digitaal Vlaanderen.
Gewestgrens
De voorbereidingen werden getroffen om in samenwerking met KLIM over te schakelen op het "Nieuw referentiebestand gemeentegrenzen, toestand 16/05/2018 (geldig vanaf 01/01/2019)".
Bug fix
Een API-request waarin het versienummer ontbreekt doet de request-logger niet meer crashen. Er wordt nu een foutboodschap getoond.
Versie 3.0.1 (beta 14/09/2018 - productie 16/10/2018)
Alle kabel- en leidingbeheerders moeten vanaf nu antwoorden via KLIP. Daarom wordt bij het indienen van een planaanvraag geen bestemmeling meer opgevraagd. Daarom is er een nieuwe API voor KLIP.
Meer info vind je bij de documentatie van de API voor Planaanvragers of die voor Kabel- en Leidingbeheerders.
API v1 - ondersteund tot 31/12/2019
Je moet niets wijzigen aan je integratie, maar achterliggend verandert het volgende:
Bij POST MapRequest wordt vanaf versie 3.0 de bestemmelingsgegevens (delivery) gebruikt om de contactgegevens in te vullen (MRI contact info).
Bij GET MapRequest:
Planaanvragen ingediend vóór versie 3.0: De bestemmelingsgegevens (delivery) wordt meegegeven.
Planaanvragen ingediend vanaf versie 3.0: contactgegevens (MRI contact info) wordt meegegeven als bestemmelingsgegevens (delivery).
API v2
Wijzigingen v2 t.o.v. v1:
Bij POST MapRequest geef je contactgegevens mee i.p.v. bestemmelingsgegevens.
Bij GET MapRequest worden de contactgegevens meegegeven maar geen bestemmelingsgegevens meer.
Bij QUERY MapRequest: er zijn een aantal ongebruikte filter-parameters verwijderd om de query te versnellen.
Documentatie
De voorbeeldcode om het signing certificaat van KLIP te valideren kreeg een update. Het certificaat wordt beter op thumbprint gecontroleerd ipv subject.
Verbeterde documentatie voor het uitfaseren van de UtilityNetworkAuth scope.
Versie 2.9.3 (productie 01/10/2018)
We stappen af van de oude AGIV-url’s, namelijk https://klip.agiv.be en https://oauth.agiv.be.
Nieuw endpoint
In productie:
https://oauth.agiv.be => https://oauth.vlaanderen.be
https://klip.agiv.be => https://klip.vlaanderen.be
Indien u SAML Assertion-inwisseling doet, past u ook volgende zaken aan:
https://auth.agiv.be => https://auth.vlaanderen.be
urn:agiv.be/oauth => urn:informateivlaanderen.be/oauth
In beta:
https://oauth.beta.agivb.e => https://beta.oauth.vlaanderen.be
https://klip.beta.agiv.be => https://beta.klip.vlaanderen.be
Indien u SAML Assertion-inwisseling doet, past u ook volgende zaken aan:
https://auth.beta.agiv.be => https://beta.auth.vlaanderen.be
urn:agiv.be/oauth => urn:informatievlaanderen.be/oauth/beta
Uitfasering scope ‘UtilityNetworkAuth’
Bij de invoering van de KLB Raadpleger (12/01/2016) wijzigden we de scopes voor de leidingbeheerders die integreren met de API naar ‘UnaReader’ en ‘UnaOperator’.
De oude scope ‘UtilityNetworkAuth’ blijft beschikbaar tot eind 2019.
Meer info over deze wijziging vindt u in de release notes van KLIP 2.0.0 op https://overheid.vlaanderen.be/help/klip/klip-webservices/changelog.
Versie 2.9.2 (beta 18/07/2018 - productie 20/07/2018)
Planaanvragers
Nieuwe features
Om technische problemen te voorkomen, moet de omtrek van de planaanvraagzone kleiner zijn dan 100.000m.
Bug fix
Verbeteren werking workers
De verwerking door KLIP verloopt hierdoor vlotter. Deze verandering heeft verder geen effect op eindgebruikers.
KLIM
De domeinnaam van de KLIM-webservices veranderde, dus KLIP heeft zijn integratie aangepast. Deze verandering heeft geen effect op eindgebruikers.
Versie 2.9.1 (beta 19/04/2018 - productie 26/04/2018)
Geen wijzigingen aan webservices.
Versie 2.8.0 (beta 01/03/2018, productie 08/03/2018)
Nieuwe features
.klip-bestanden:
De .klip-bestanden zijn nu ook beschikbaar via de API-methode. Meer info vind je bij de documentatie van de services.
Bug fixes
IMKL:
Het is niet langer mogelijk om vanuit een object te verwijzen naar meerdere identieke objecten.
Voorbeeld: vanuit een duct verwijzen naar twee dezelfde extra plannen.
<imkl:Duct gml:id="1"> <imkl:heeftExtraInformatie xlink:href="http://mir.agiv.be/data/IMKL/v2.3/ExtraPlan/mynamespace:1"></imkl:heeftExtraInformatie> <imkl:heeftExtraInformatie xlink:href="http://mir.agiv.be/data/IMKL/v2.3/ExtraPlan/mynamespace:1"></imkl:heeftExtraInformatie> </imkl:Duct>
KLIM
Het end point van de KLIM-webservices veranderde, dus KLIP heeft zijn integratie aangepast. Deze verandering heeft geen effect op eindgebruikers.
Versie 2.7.2 (productie 12/01/2018)
Archivering
Verbetering stabiliteit en optimalisatie archiveringsproces.
Versie 2.7.1 (beta 14/12/2017, productie 21/12/2017)
Webservices
URL:
Sinds release 2.6 zijn we afgestapt van de oude AGIV-url’s. De KLIP omgeving raadpleeg je voortaan op dit adres: https://klip.vlaanderen.be (productie-omgeving) en https://beta.klip.vlaanderen.be/ (bèta-omgeving).
Het IP-adres van de applicatie wijzigt naar 13.69.26.42. Dit is enkel belangrijk voor organisaties waar het KLIP als applicatie moet worden toegelaten in een firewall.
Ook voor integratoren wijzigt het service endpoint. Het oude endpoint ondersteunen we nog tot eind 2018. We vragen met aandrang om zo snel mogelijk over stappen op het nieuwe endpoint om eventuele integratieproblemen tijdig op te lossen.
IMKL 2.3:
IMKL 2.3 werd gereleased op 24 augustus 2017.
Vanaf 23 augustus 2018 zullen antwoorden volgens de IMKL 2.2-specificaties niet meer aanvaard worden.
Versie 2.7.0 (beta 09/11/2017, productie 12/12/2017)
Webservices
Nieuwe features
Archivering:
Gearchiveerde planaanvragen zijn enkel bereikbaar via de webtoepassing
Wanneer een gearchiveerde planaanvraag opgevraagd wordt, zal je een 404-melding krijgen
Versie 2.6.1 (beta 07/09/2017, productie 07/09/2017)
Geen wijzigingen aan webservices.
Versie 2.6.0 (beta 11/05/2017, productie 24/08/2017)
Wijziging van de URL
We stappen ook af van de oude AGIV-url’s. De KLIP omgeving raadpleeg je voortaan op dit adres: https://klip.vlaanderen.be (productie-omgeving) en https://beta.klip.vlaanderen.be/ (bèta-omgeving).
Het IP-adres van de applicatie wijzigt naar 13.69.26.42. Dit is enkel belangrijk voor organisaties waar het KLIP als applicatie moet worden toegelaten in een firewall.
Gebruikers van de webapplicatie verwijzen we automatisch door naar het nieuwe adres.
Ook voor integratoren wijzigt het service endpoint. Het oude endpoint ondersteunen we nog tot eind 2018. We vragen met aandrang om zo snel mogelijk over stappen op het nieuwe endpoint om eventuele integratieproblemen tijdig op te lossen.
Webservices
Nieuwe features
IMKL 2.3:
IMKL 2.3 maakt gebruik van versie 4.0 van de INSPIRE xsd's voor Utility networks
Aanpassing van het UML schema aan het IMKL 2.3 model volgens onderstaande omschrijvingen:
Toevoeging nieuw object “BeschermdGebied” met volgende relatie:
inNetwork
Het is niet meer mogelijk om extra topografie in rasterformaat door te geven. Verwijdering van volgende attributen in object “ExtraTopografie”:
rasterBestandLocatie
rasterBestandMediaType
Koppeling van het mixin object “label” op het object “ActivityComplex”
Enkel volgende karakters worden nog toegelaten in bestands- of mapnamen:
a-z
A-Z
0-9
- (koppelteken)
_ (underscore)
(spatie)
. (punt)
+
!
(
)
Toevoeging optioneel attribuut "temperatuur" bij ThermalPipe
Toevoeging definitie voor subThema “elektriciteitKathodischeBescherming”
Uitbreiding volgende codelijsten:
MaterialTypeValue
ElectricityAppurtenanceTypeIMKLValue
ThermalProductTypeIMKLValue
ThermalAppurtenanceTypeIMKLValue
ThermalSubThemaValue
“Bugfixes”
Verplicht in te vullen velden: nilReasons worden niet meer aanvaard
Weigeren linestrings met 2 identieke punten
Weigeren fictieve UtilityLinks
CDATA-tags worden niet meer aanvaard
Bulktesten van IMKL-pakketten:
IMKL-testpagina ook bereikbaar met API
service accounts met rol KLB operator
resultaat: url naar website met resultaat van de validatie
1 maand beschikbaar
URL raadpleegbaar voor iedereen met KLIP-rol
De validatie van IMKL-pakketten werd sneller gemaakt
Versie 2.5.3 (beta 14/02/2017, productie 23/02/2017)
Geen wijzigingen aan webservices.
Versie 2.5.2 (productie 18/01/2017)
Geen wijzigingen aan webservices.
Versie 2.5.1 (productie 12/01/2017)
Geen wijzigingen aan webservices.
Versie 2.4.3 (productie 4/11/2016)
Opgeloste bugs
Downloaden van PMKL faalt soms
IMKL-bestand opladen faalt soms
Versie 2.4.1 (beta 28/09/2016, productie 06/10/2016)
Opgeloste bugs
diverse technische bugfixes na de eerste bèta testperiode van KLIP 2.4.1
oplossing voor falende prints
Versie 2.4.0 (beta 15/09/2016)
Geen wijzigingen aan webservices.
Versie 2.3.0 (beta 02/08/2016, productie 04/08/2016)
Geen wijzigingen aan webservices.
Versie 2.2.0 (productie 02/06/2016)
Geen wijzigingen aan webservices.
Versie 2.1.0 (productie 31/03/2016)
Webservices
De SSL certificaten waarmee KLIP de validatierapporten digitaal ondertekent werden vernieuwd
Informatie nieuwe certificaten:
Bèta:
Thumbprint: 2081c1d735b2f224d61c13f7e29e3b056afa2529
Subject: E = security@agiv.be, CN = signing.klip.agiv.be/beta, OU = IT-Dienst, O = 0881746529, L = Gent, S = Oost-Vlaanderen, C = BE
Download (certificaat + chain)
Productie:
Thumbprint: d5d39a8c82fd1d68b5d86fbe94ed96ac8f8f9953Subject: E = security@agiv.be, CN = signing.klip.agiv.be/prod, OU = IT-Dienst, O = BELVPOVO00029510, L = Gent, S = Oost-Vlaanderen, C = BE
Download (certificaat + chain)
Versie 2.0.0 (productie 12/01/2016)
Webservices
Nieuwe features
Nieuwe rol en scopes:
Rol KLB Raadpleger:
Een gebruiker met deze rol kan alle planaanvragen die zijn organisatie (of een suborganisatie) moet beantwoorden zien. Hij kan planaanvragen niet bevestigen of beantwoorden.
Deze rol is bedoeld voor medewerkers die de planaanvragen wel mogen zien, maar niet mogen tussenkomen in het antwoordproces.
Scopes:
UnaReader en UnaOperator
Welke rol kan welke scopes opvragen?
Rol Scopes (na transitie) KLIP KLB Beheerder / KLIP KLIM Beheerder / KLIP KLB Operator UnaReader, UnaOperator KLIP KLB Raadpleger UnaReaderDe scope UtilityNetworkAuth (enkel voor KLIP KLB Operator) blijft nog even beschikbaar.
IMKL-validatie:
Appurtenance van het thema water: de appurtenancetypes http://mir.agiv.be/cl/IMKL/v2.1/SewerAppurtenanceTypeIMKLValue/kbVoedingsbron en http://mir.agiv.be/cl/IMKL/v2.1/SewerAppurtenanceTypeIMKLValue/kbSpoor werden verwijderd.
Uitbreiding codelijst Materiaaltype
jute wordt als "jute" toegevoegd: http://mir.agiv.be/cl/IMKL/v2/MaterialTypeValue/jute
XLPE wordt als "crossLinkPolyethyleen" toegevoegd: http://mir.agiv.be/cl/IMKL/v2/MaterialTypeValue/crossLinkPolyethyleen
Uitbreiding codelijst ExtraPlanType
dwarsprofiel wordt toegevoegd: http://mir.agiv.be/cl/IMKL/v2/ExtraPlanTypeValue/dwarsprofiel
Volgende attributen zijn nillable:
ElectricityCable: nominalVoltage en operatingVoltage
OilGasChemicalsPipe: pipeDiameter en pressure
SewerPipe: pipeDiameter
WaterPipe: pipeDiameter
ThermalPipe: pipeDiameter
Pipe: pipeDiameter
Duct: ductWidth
Omdat hele grote xml-bestanden problemen gaven bij het inladen in de viewer, werd de maximale grootte van het uitgepakte xml-bestand in een IMKL-antwoord beperkt tot 50 MB. De maximale grootte van het zip-pakket zelf (500 MB) blijft ongewijzigd.
Versie 1.2.1 (beta 13/10/2015)
Webservices
Nieuwe features
API-aanpassingen:
Opvragen van de KLB-zones van een KLB: ook de gearchiveerde zones worden teruggegeven (GET https://klip.beta.agiv.be/api/ws/klip/v1/Una)
Opvragen van de gegevens van een KLB-zone: ook de namespace wordt nu meegegeven in het antwoord (https://klip.beta.agiv.be/api#GETws/klip/v1/UnaZone/{unaZoneId})
Opgeloste bugs
KLIM:
Het detail van een planaanvraag kan door een KLIM KLB opgevraagd worden zolang KLIP niet weet of de KLIM KLB bij de planaanvraag betrokken is.
Technisch:
Indien de service bus offline is omwille van een infrastructureel probleem, kunnen events niet op de bus gezet worden en worden ze niet gedeadlettered.
Versie 1.2.0 (productie 29/09/2015)
Webservices
Nieuwe features
API-aanpassingen:
Bij het aanmaken van een planaanvraag kunnen één of meerdere tags toegevoegd worden. Een tag is een (relevant) sleutelwoord of term. De tag geeft aanvullende informatie over de planaanvraag waardoor ze gemakkelijker kan worden teruggevonden bij zoeken. Volgende API methodes zijn hiervoor aangepast:
IMKL-validatie:
IMKL-pakketten met UtilityLinks die niet gerefereerd worden vanuit een kabel- of leiding zijn niet geldig
Een utilityNetwork moet minstens een kabel, leiding, leidingelement, containerleiding, containerleidingelement, activity complex, extra informatie (al dan niet aan het netwerk zelf) of extra topografie (enkel de relatie 'heeftExtraTopografieen') binnen 500 meter van de planaanvraagzone bevatten.
Validatie op het niveau van een IMKL-pakket blijft onveranderd.
Een geldig IMKL pakket moet minstens een kabel, leiding, leidingelement, containerleiding, containerleidingelement, activity complex, binnen 500 meter van de planaanvraagzone bevatten.
IMKL-codes:
Er werden nieuwe IMKL-codes toegevoegd
MateriaalType
Subthema Electricity
elektriciteitKathodischeBescherming (http://mir.agiv.be/cl/IMKL/v2/ElectricitySubThemaValue/elektriciteitKathodischeBescherming)
SubThema Telecommunications
Telecommunicatie distributie (http://mir.agiv.be/cl/IMKL/v2/TelecommunicationsSubThemaValue/telecommunicatieDistributie)
Telecommunicatie hoofdlijn (http://mir.agiv.be/cl/IMKL/v2/TelecommunicationsSubThemaValue/telecommunicatieHoofdlijn)
AppurtenanceType Telecommunications
Verwerking planaanvragen:
Wijziging in de manier waarop het planaanvraagproces afgehandeld wordt: kortdurende processen (indienen van een planaanvraag, bevestigen van een planaanvraag, …) werden afgescheiden van langdurende processen (opladen van IMKL, …). Hierdoor kunnen we meer gericht schalen en willen we de performantie van de website en de API verbeteren.
Opgeloste bugs
Api queries (api/ws/klip/v1/MapRequest/Mri en api/ws/klip/v1/MapRequest/Una) geven enkel correct resultaat indien je zoekt op datum en niet als je zoekt op datum en tijd. Dit werd opgelost.
IMKL-validatie: het apppurtenancetype http://mir.agiv.be/cl/IMKL/v2.1/SewerAppurtenanceTypeIMKLValue/kbInstallatie ontbrak. Dit werd opgelost.
Versie 1.1.1 (productie 04/08/2015)
Webservices
Verstrenging van de IMKL validatie voor ExtraPlan.ligging en ExtraTopografie.ligging.
Voor ExtraPlan.ligging is enkel LineString, Polygon en Point toegelaten.
Voor ExtraTopografie.ligging is LineString, Polygon, Point en MultiGeometry toegelaten. Voor MultiGeometry is enkel Point, LineString en Polygon toegelaten.
Versie 1.1.0 (productie 20/07/2015)
Geen wijzigingen aan webservices.