Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

RESTful diensten - info

Algemeen

DIV heeft einde 2019 aangekondigd dat het in de loop van 2020 de SOAP diensten zal vervangen door nieuwe REST diensten die op een vernieuwd, performanter platform zullen draaien. Deze pagina’s beschrijven de nieuwe diensten zoals MAGDA ze zal aanbieden.

MAGDA zal de nieuwe DIV REST diensten aanbieden in REST formaat, en daarin de datastructuren van DIV overnemen. Elke DIV REST dienst zal dus beschikbaar worden op het MAGDA platform.

Opmerking:

Hou aub rekening met opmerkingen in onderstaande versioneringstabel. Ontwikkelingen zijn gestart dus zullen mogelijke wijzigingen nog minimaal zijn.

Datum Aanpassing

Basis

Wijzigingen (verwacht/uitgevoerd)

Datum Aanpassing

Basis

Wijzigingen (verwacht/uitgevoerd)

Apr 28, 2020

Swaggers DIV Mar 20, 2020

  • Basisvertaling (uitgevoerd)

  • OSLO compliance nog aan te vullen (verwacht)

  • Aanpassingen op basis van vragen VLABEL: een vijftal ontbrekende velden (verwacht)

  • Er komt in mei dus nog een nieuwe versie, zonder wijziging aan de functionaliteit (verwacht)

May 11, 2020

Swaggers DIV May 11, 2020

  • Aanpassing op DIV swaggers van 11 mei meegenomen (uitgevoerd)

  • OSLO compliance is opgenomen, enkel basis, moet nog gecorrigeerd worden (verwacht)

  • Aanpassingen op basis van vragen VLABEL: een vijftal ontbrekende velden (verwacht)

  • Midden juni komt een update van MAGDA swaggers op basis van een DIV revisie einde mei (verwacht)

Jun 16, 2020

Swaggers DIV Jun 12, 2020

Aug 26, 2020

Swaggers DIV Aug 26, 2020

Sep 21, 2020

Swaggers DIV Aug 26, 2020

  • Toevoegen HTTP statuscode 204 (in anticipatie van uitbreiding DIV swaggers met HTTP status code 204)

  • De nieuwe swaggers zijn te vinden hieronder op deze pagina

Sep 28, 2020

Swaggers DIV Aug 26, 2020

  • Toevoegen header parameter “X-Magda-Enduser-Id”

    • De nieuwe parameter is een verplichte parameter waarin de gebruiker van de dienst een referentie dient mee te geven over welke user/welk proces verantwoordelijk is voor het aanroepen van de dienst. Aanroeper van de dienst moet op verzoek van DIV de referentie terug kunnen brengen naar de effectieve gebruiker die de dienst heeft gebruikt.

  • verwijderen van registationsHistory/transactions & registrationsHistory/certificates in de beschikbare swaggers

    • beide diensten zijn niet beschikbaar voor regionale afnemers.

Oct 20, 2020

Swaggers DIV Aug 26, 2020

  • Correctie van datatype datetime naar date-time in swaggers registrationsHistory, registrations, registrationsTitular.

Nov 30, 2020

Swaggers DIV Nov 27, 2020

  • toevoeging van het element legalFormAbbrev in de response van registrations en registratoinsTitular

 

Feb 8, 2021

Swaggers DIV Nov 27, 2020

Uitbreiding functionaliteit in diensten registrationsTitular en registrations. Optioneel kunnen de diensten registrationsTitular en registrations vanaf nu ook het actuele adres van de titularis teruggeven in het antwoord. Dit adres is in het antwoord beschikbaar onder “currentAddress”.

Deze wijziging is volledig optioneel en 100% backward compatible.

Het adres dat de diensten registrationsTitular en registrations door DIV wordt terug gegeven moet als “adres bij inschrijving” geïnterpreteerd worden. Dit adres is dus niet geschikt om te gebruiken als adres waarnaar communicatie gestuurd kan worden.

De functionaliteit van het actuele adres is nog in ontwikkeling en wordt in T&I verwacht tegen half februari. Deze pagina bevat wel al de aangepaste swaggers.

Migratie van de SOAP naar de REST diensten

Onderstaande lijst geeft een overzicht van de verschuiving van de oude SOAP diensten naar de nieuwe REST diensten. Er is geen 1 op 1 vervanging daar de REST diensten een aggregatie van informatie betekenen. Daarnaast zullen de FTP exports vervangen worden door een REST dienst waardoor afnemers genoodzaakt zijn om de mutaties zelf op te vragen in plaats van deze aangeboden te krijgen.

Authenticatie

De service consumer vraagt een OAuth token aan op de DIV OAuth server dat vervolgens gebruikt wordt om de effectieve service call te doen. Dit is een standaard proces voor alle aansluitingen via REST diensten op MAGDA, ook voor alle andere domeinen.

Dit token wordt meegegeven bij de request naar de REST dienst. Verdere uitleg over het OAuth token en het opvragen ervan: ACM OAuth - Token-gebaseerde diensten MAGDA .

Hieronder het overzicht van de verschillende scopes en welke diensten ze bevatten:

Scope

Diensten

Scope

Diensten

mob_cbt_v1_G

  • GET crossborderTitulars

mob_movind_v1_G

  • GET movementIndications/registrationsNew

  • GET movementIndications/registrationsChangedDataLicense

  • GET movementIndications/registrationsChangedDataVehicle

  • GET movementIndications/registrationsTransferred

  • GET movementIndications/registrationsUnregistered

  • GET movementIndications/registrationsCrossedOut

  • GET movementIndications/transactions

mob_reg_v1_G

  • GET registrations

mob_reghist_v1_G

  • GET registrationsHistory

  • GET registrationsHistory/transactions

  • GET registrationsHistory/certificates

mob_regtit_v1_G

  • GET registrationsTitular

 

Swaggers

Impact op bestaande MAGDA diensten

Magda dienst

Impact

Magda dienst

Impact

Mobiliteit LEZ ControleerToegangOpDatum - CSV batch verwerking

Impact gedragen door MAGDA platform, geen impact naar afnemers

Mobiliteit.ControleerToegang-02.00

Impact gedragen door MAGDA platform, geen impact naar afnemers

Mobiliteit.ControleerToegangOpDatum-02.00

Impact gedragen door MAGDA platform, geen impact naar afnemers

Mobiliteit.GeefBuitenlandsVoertuig-02.00

Dienst buiten gebruik bij afschakeling SOAP service door DIV. Afnemers moeten migreren naar GET mobility/crossborderTitulars - v1archived

Mobiliteit.GeefVoertuig-02.00

Dienst buiten gebruik bij afschakeling SOAP service door DIV. Afnemers moeten migreren naar GET mobility/registrationsTitular - v1

 

 


Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid

uitgegeven door Digitaal Vlaanderen