Verschil API v3 met API v2

Aangezien de authenticatie via ACM steeds gebeurt op het niveau van een hoofdorganisatie, waren een aantal aanpassingen nodig in de KLIP-API om acties te kunnen ondernemen in naam van een suborganisatie.  

De vernieuwde API wordt hier beschreven: https://klip.api.beta-vlaanderen.be/api/swagger/index.html (bèta-omgeving) en https://klip.api.vlaanderen.be/api/swagger/index.html (productie).

Let op, deze nieuwe API heeft ook nieuwe endpoints!

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)

Andere wijzigingen:

1. Voor volgende calls moet nu ook een organisatieID worden meegegeven:  

   1. POST 

      1. /ws/klip/v3/maprequest (organisationID is een verplicht mee te geven veld) 

   2. GET 

      1. ​/ws​/klip​/v3​/imkl​/maprequest​/{MapRequestId}​/mri​/{OrganisationId} (ID is hier nodig om te weten op welke factuur het IMKL-pakket geplaatst moet worden) 

      2. ​/ws​/klip​/v3​/una​/getbyorganisation​/{OrganisationId} 

2. De statussen werden ingekort van url naar korte codes

   1. voorbeeld: "https://klip.vlaanderen.be/api/cl/klip/v2/MapRequestStatus/created" werd "created"

3. Het defaultformaat voor de API-berichten is JSON, al blijft het mogelijk om XML-berichten te versturen. Stuur hiervoor in de "Content-Type" header application/xml mee. 

4. Nieuwe functionaliteit: het opvragen van de organisatiestructuur en OrganisatieId’s. 

Enkel voor leidingbeheerders: vanaf nu is het ook mogelijk om de antwoordstatus van een planaanvraag op te halen. Een planaanvraag kan pas beantwoord worden wanneer ze de status ‘confirmed’ heeft.  

Aangewezen antwoordproces: 

1. Vraag te bevestigen planaanvragen op 

2. Bevestig planaanvragen 

3. Vraag te beantwoorden planaanvragen op 

4. Vraag details te beantwoorden planaanvragen op 

5. Beantwoord de planaanvragen

Alternatief antwoordproces: 

1. Vraag te bevestigen planaanvragen op 

2. Bevestig de planaanvraag 

3. Vraag details planaanvraag op 

4. Kijk na of de status van de planaanvraag aangepast is naar ‘confirmed’ 

5. Beantwoord planaanvraag 

Opgelet: KLIP verwerkt de API calls asynchroon.
Wacht om het antwoord op een planaanvraag door te sturen tot planaanvraag effectief bevestigd is.