Versions Compared

Old Version 9

changes.mady.by.user Evelien Dheer

Saved on

compared with

New Version Current

changes.mady.by.user Frank Wambacq

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

Security EDIT API

OAuth Rest API voor server-naar-server

https://authenticatie.vlaanderen.be/docs/beveiligen-van-api/oauth-rest/rest-server2server/

Momenteel 3 scopes beschikbaar:

  • Orafin/Departement Financiën en Begroting

    • Beheer sleutels

  • Kiosk/Departement Cultuur, Jeugd en Media

    • Beheer sleutels

    • Beheer bankrekeningnummers

    • Aanmaken organisaties obv kbo nummers

    • Beheer contacten

    • Beheer classificaties

  • testclient (Digitaal Vlaanderen)

    • Toegang tot alle edit api functionaliteit

API Documentatie

https://api.organisatie.dev-vlaanderen.be/docs/api-documentation.html

API Formaat algemeen

PUT POST wordt gebruikt om iets nieuws aan te maken, POST PUT wordt gebruikt om bestaande data aan te passen

<startURL> in staging: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations

Table of Contents
minLevel1
maxLevel7

API - Organisaties

Mogelijkheden: Maak nieuwe aan op basis van KBO nummer

...

Code Block
https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/kbo/0316380841

Body: leeg

API - Bankrekeningnummers

Mogelijkheden: nieuw aanmaken (create) & bestaande wijzigen (update)

...

Code Block
create: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/70fa7d83-f336-0ede-e1b2-503e3b4f5e57/bankaccounts
update: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/70fa7d83-f336-0ede-e1b2-503e3b4f5e57/bankaccounts/084a0921-3c08-4b77-a994-2aba33c09b04

Body:
{
    "bankAccountNumber": "BE68539007547034",
    "isIban": "true",
    "bic": "GEBABEBB"
    "validFrom": "2022-01-01",
    "validTo": "2050-12-31"
}

API - Sleutels

Mogelijkheden: nieuw aanmaken (create) & bestaande wijzigen (update)

...

  • Sleutel type moet bestaan

  • Sleutel type moet toegestaan zijn:

    CJM mag VOP en Onderwijsdatabank beheren

    • DFB mag Orafin sleutel beheren

    • CJM + onze eigen testclient mag mogen alles beheren

  • Indien geldig van en/of tot zijn ingevuld → moet correct datum formaat zijn

  • Sleutels van eenzelfde sleuteltype mogen niet overlappen in tijd (er mag geen identiek sleuteltype op het zelfde moment geldig zijn)

...

Code Block
create: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/70fa7d83-f336-0ede-e1b2-503e3b4f5e57/keys
update: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/70fa7d83-f336-0ede-e1b2-503e3b4f5e57/keys/2827dada-042e-47ca-aa83-dd70106a38cb

Body:
{
    "keyTypeId": "939a72cb-01b8-7edb-f373-bb0370433c95",
    "keyValue": "1234",
    "validFrom": "2022-01-01",
    "validTo": "2050-12-31"
}

API - Classificaties

Mogelijkheden: nieuw aanmaken (create) & bestaande wijzigen (update)

...

Code Block
create: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/70fa7d83-f336-0ede-e1b2-503e3b4f5e57/classifications
update: https://api.organisatie.dev-vlaanderen.be/v1/edit/organisations/70fa7d83-f336-0ede-e1b2-503e3b4f5e57/classifications/aaf5b0c3-1bec-452a-bef8-70565786d843

Body:
{
    "organisationClassificationTypeId": "c35407e4-8559-08d4-f461-a8247c993d58",
    "organisationClassificationId": "b0fe0974-31dd-e54b-9d7f-af73b8fd5869",
    "validFrom": "2022-01-01",
    "validTo": "2050-12-31"
}

API - Contacten

Mogelijkheden: nieuw aanmaken (create) & bestaande wijzigen (update)

...