Versions Compared

Old Version 3

changes.mady.by.user oliver.may

Saved on

compared with

New Version Current

changes.mady.by.user Bavo Van Eyken

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

During the transition there are 2 major work blocks: changing the authentication and switching to the renewed GIPOD API. 

The renewed GIPOD API ( gipod.api.vlaanderen.be ) will work with both Geosecure and ACM authentication, but the existing GIPOD API ( private-api.gipod.vlaanderen.be ) will only work with Geosecure authentication.

Therefore we recommend switching to the renewed API & changing the authentication in one go.

Note

On the renewed API rate limiting is applied. Each client is allowed to perform 1800 req/min.

TL;DR for CCG with JWK

Beta

Production

  1. Validate in Beheerportaal T&I that your existing client was successfully migrated to ACM, and remember the new client id.

  2. Adapt oauth access token request information and update oauth URLs from beta.oauth.vlaanderen.be/... to authenticatie-ti.vlaanderen.be/... using the

...

  1. client id from step 1.

  2. Update GIPOD API endpoint from private-api.gipod.beta-vlaanderen.be to gipod.api.beta-vlaanderen.be

  3. Validate that your existing client

...

  1. works with the new endpoints

...

  1. and authentication mechanism

  1. Validate in Beheerportaal that your existing client was successfully migrated to ACM, and remember the new client id.

  2. Adapt oauth access token request information and update oauth URLs from oauth.vlaanderen.be/... to authenticatie.vlaanderen.be/... using the

...

  1. client id from step 1.

  2. Update GIPOD API endpoint from private-api.gipod.vlaanderen.be to gipod.api.vlaanderen.be

  3. Validate that your existing client

...

  1. works with the new endpoints

...

Introduction

...

  1. and

...

The renewed GIPOD API ( gipod.api.vlaanderen.be ) will work with both Geosecure and ACM authentication, but the existing GIPOD API ( private-api.gipod.vlaanderen.be ) will only work with Geosecure authentication.

Therefore we recommend switching to the renewed API & changing the authentication in one go.

  1. authentication mechanism

Set up clients in ACM 

The current Geosecure clients are being phased out. 

...

More information about moving from Geosecure clients to ACM clients: https://confluencevlaamseoverheid.voalm.vlaanderen.beatlassian.net/wiki/display/GAEP/Scenario%2527s%2Bvoor%2Boverschakeling%2Bvan%2Bde%2BAPI-clients  

More information about managing Client Credential Grant clients in ACM: https://confluencevlaamseoverheid.voalm.vlaanderen.beatlassian.net/wiki/display/GAEP/Module%2BOAuth%2BClient%2BCredentials%2BGrant%253A%2BAPI-Client%2Bbeheren  

Authenticate on the GIPOD API with an ACM token

...

To connect to the GIPOD API you need a signed JWT token. To do this, work with a Client credentials grant .

More information about server-server authentication can be found here and about creating a signed JWT token here .

Adjustments of the GIPOD API endpoint

The renewed GIPOD API endpoint ( https://gipod.api.vlaanderen.be ) will work with both Geosecure and ACM authentication, but the existing GIPOD API endpoint ( https://private-api.gipod.vlaanderen.be ) will only work with Geosecure authentication. 

...