API-standaarden
Standaard API-specificaties[bewerken]
Een verbindend verklaarde API-standaard is na een advies van het College van Dienstverleningszaken door het VNG-bestuur of de Algemene Ledenvergadering van de VNG als standaard vastgesteld. Een vaststelling kan verschillende gradaties van verbindendheid tot gevolg hebben: van 'aanbevolen deze standaard te gebruiken' tot 'verplicht deze standaard toe te passen'. In de tabel wordt per vastgestelde API-standaard aangegeven welke mate van verbindendheid geldt.
Standaarden kunnen op drie niveaus worden vastgesteld:
- Aanbevolen: toepassing van de standaard wordt vrijblijvend geadviseerd; de standaard kent geen formele status.
- Pas toe of leg uit: de vastgestelde standaard moet worden toegepast, tenzij er zwaarwegende redenen zijn dat niet te doen. Over deze redenen wordt volgens het ‘pas toe of leg uit’-principe gerapporteerd.
- Verplicht: de vastgestelde standaard moet zonder uitzondering worden toegepast.
| API-standaard | In beheer bij | In ontwikkeling - 1.0-versie verwacht in | In gebruik (versie ≥ 1.0 ) vanaf datum | Mate van verbindendheid |
|---|---|---|---|---|
| Onderdeel van API-standaarden in domein Dienstverlening (Zaakgericht werken) | ||||
| Zaken API | VNG Realisatie | 27-11-2019 | pas toe of leg uit | |
| Catalogi API | VNG Realisatie | 27-11-2019 | pas toe of leg uit | |
| Documenten API | VNG Realisatie | 27-11-2019 | pas toe of leg uit | |
| Besluiten API | VNG Realisatie | 27-11-2019 | pas toe of leg uit | |
| Autorisaties API | VNG Realisatie | 27-11-2019 | pas toe of leg uit | |
| Notificaties API | VNG Realisatie | 27-11-2019 | pas toe of leg uit | |
| Objecten API Objecttypen API |
OpenZaak Community | 13-01-2021 | pas toe of leg uit | |
| Onderdeel van Haal Centraal | ||||
| BAG Bevragen API | 13-8-2020 | nader te bepalen | ||
| BRK Bevragen API | 3-6-2020 | nader te bepalen | ||
| BRP Bevragen API | 01-10-2020 | nader te bepalen | ||
| Onderdeel van API-standaarden in Fysiek domein | ||||
| Regels bij activiteiten API | VNG Realisatie | 01-07-2021 | pas toe of leg uit | |
API-specificaties in ontwikkeling[bewerken]
Een compleet overzicht van alle in ontwikkeling zijnde API-specificaties is te vinden op de ontwikkelagenda API-standaarden.
Heb je zelf een idee voor een standaard? Volg dan het standaardisatieproces, welke de leidraad geeft van te volgen stappen om van ‘idee’ tot ‘vastgestelde VNG uitwisselstandaarden’ te komen.