Skip to content

Amsterdam/mijn-mks-api

Folders and files

NameName
Last commit message
Last commit date
May 6, 2024
Jan 21, 2025
Nov 1, 2023
Apr 17, 2024
Sep 25, 2024
Apr 2, 2019
Jan 3, 2022
Aug 23, 2021
Apr 17, 2024
Nov 1, 2023
Sep 25, 2024
Nov 14, 2024
Apr 17, 2024
Aug 29, 2024

Repository files navigation

MKS API

Deze api levert de volgende data:

  • Persoonsgegevens uit de BRP
  • HR gegevens op basis van BSN (+kvk nummer) (zzp'er)
  • HR gegevens op basis van KVK nummer
  • Overzicht ID kaarten en Paspoorten

Local env

// Initialize

  • python -m venv venv
  • Mac: source venv/bin/activate Windows: .\venv\Scripts\Activate.ps1 (in case of UnauthorizedAccess run Set-ExecutionPolicy Unrestricted -Scope Process beforehand)
  • pip install -r requirements-root.txt

// unittest python -m unittest

// requirements.txt maken make requirements

// dev server sh scripts/run-dev.sh

Kenmerken

  • Het bronsysteem is een soap/stuf api MKS, deze haalt gegevens uit de brp.
  • Het bronsysteem wordt bevraagd op basis van een BSN of KVK nummer.
  • De output van de api is JSON formaat.

Dependencies

  • Voeg de naam van de library/dependency toe aan requirements-root.txt
  • Voer volgende commando uit: make requirements

Development & testen

  • Er is geen uitgebreide lokale set-up waarbij ontwikkeld kan worden op basis van een "draaiende" api. Dit zou gemaakt / geïmplementeerd moeten worden.
  • Alle tests worden dichtbij de geteste functionaliteit opgeslagen. B.v some_service.py en wordt getest in test_some_service.py.

CI/CD

  • De applicatie wordt verpakt in een Docker container.
  • Bouwen en deployen van de applicatie gebeurt in Github en Azure DevOps.

Release to production

~ cd scripts
~ ./release.sh --minor [--major [--patch]]

About

No description, website, or topics provided.

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published