De ‘Bevraging reisdocumenten’ Web API is gespecificeerd in OpenAPI specifications (OAS).
Wil je de API gebruiken? Dit kun je doen:
Met deze API kun je gegevens over een reisdocument ophalen met het reisdocumentnummer.
Je kunt een visuele representatie van de specificatie bekijken met Swagger UI.
Je kunt de functionele documentatie vinden in de features.
Client code kun je genereren met de “genereervariant” van de API-specificaties en een code generator. Een overzicht met codegeneratoren kun je vinden op OpenAPI.Tools.
Deze repo bevat scripts waarmee je met OpenAPI Generator client code kunt genereren in JAVA, .NET (Full Framework & Core) en Python. De makkelijkste manier om de code generatie scripts te gebruiken, is door deze repo te clonen. Na het clonen kun je met npm install de benodigde packages installeren en kun je met npm run
Een lijst met andere ondersteunde generator opties kun je vinden in de Generators List van OpenAPI Generator.
Note. De prerequisite van OpenAPI Generator is JAVA. Je moet een JAVA runtime installeren voordat je OpenAPI Generator kunt gebruiken
Je kunt deze Haal Centraal API niet proberen in de demo-omgeving (www.haalcentraal.nl/haalcentraal/api/) omdat de achterliggende bron (GBA-V obv autorisatietabel 35) geen autorisaties voor reisdocumenten bevat. Voorbeeldberichten zijn wel beschikbaar.
Onderstaande tabel bevat enkele voorbeeld antwoordberichten.
| reisdocumentnummer | situatie |
|---|---|
| NUR9J1JP7 | nationaal paspoort uitgegeven door gouverneur |
| BD8P7H2C7 | vermist |
| HPB1234HG | verlopen identiteitskaart |
| BT6F58F32 | uitgegeven door consulaire post |
| RJR0JL7J7 | reisdocument voor vluchtelingen |
| IX24PJ6B4 | geheimhouding |