forked from postcodeapi/postcodeapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
666 lines (661 loc) · 21.3 KB
/
swagger.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
swagger: "2.0"
info:
version: "2.0"
title: Postcode API
description: |
De Postcode API gebruikt Open Data van Kadaster's [BAG](http://bag.kadaster.nl) en Open Data van het [CBS](http://www.cbs.nl). Alle mogelijke API calls zijn beschreven in deze specificatie. Voor support en suggesties voor verbeteringen of feature requests verwijzen we je naar de *issues* sectie onze Open Source Github repository: https://github.com/apiwise/postcodeapi.
### Parameters
Alle parameters die hier beschreven staan zijn query parameters en dienen als zodanig met de URL meegestuurd te worden, bijvoorbeeld:
`https://api.postcodeapi.nu/v2/addresses?page=3&postcodeArea=6545`
*Let op: deze link werkt nog niet omdat de API zelf nog gerealiseerd moet worden*
### Hypermedia
Alle responses van deze API bevatten [JSON API](http://jsonapi.org/) *hypermedia links* om door de data te kunnen navigeren. Deze navigatie vind je in de `links` objecten.
contact:
name: Apiwise
url: http://www.apiwise.nl
email: [email protected]
host: api.postcodeapi.nu
basePath: /v2
schemes:
- https
produces:
- application/vnd.api+json
securityDefinitions:
apiKey:
type: apiKey
name: Api-Key
in: header
description: |
De gehele API is beveiligd met een Api Key. Deze key heb je gekregen tijdens de registratieprocedure. Wij gebruiken deze vorm van authenticatie om het gebruik van deze dienst te kunnen monitoren en contact op te kunnen nemen met de afnemer mocht er (onbewust) misbruik van de dienst gemaakt worden.
Het meesturen van de Api Key gebeurt met de zogenaamde `Api-Key` request header. Bijvoorbeeld: `Api-Key: a0B1c2D34D5c6b7a8`.
security:
- apiKey: []
tags:
- name: address
description: Adres calls
- name: postcode
description: Postcode calls
- name: postcodeArea
description: Postcodegebied calls
paths:
/addresses:
x-swagger-router-controller: address
get:
tags: [address]
summary: Alle adressen
description: Alle adressen in Nederland, gepagineerd per 20 records
operationId: findAddresses
parameters:
- name: page
in: query
type: integer
required: false
minimum: 1
maximum: 1000000
default: 1
x-example: 1
description: Paginanummer voor paginering
- name: postcodeArea
in: query
type: integer
required: false
x-example: 6545
description: Filteren op postcodegebied in *P4* formaat
- name: postcode
in: query
type: string
required: false
x-example: 6545CA
description: Filteren op postcode in *P6* formaat
- name: number
in: query
type: integer
required: false
x-example: 29
description: Filteren op huisnummer (alleen in combinatie met postcode of straat)
- name: street
in: query
type: string
required: false
x-example: Binderskampweg
description: Filteren op straatnaam
- name: cityId
in: query
type: string
required: false
x-example: "268200000075156"
description: Filteren op identifier van de woonplaats, gelijk aan die van de overheidstandaard BAG
- name: municipalityId
in: query
type: string
required: false
x-example: "3030"
description: Filteren op identifier van de gemeente, gelijk aan die van de overheidstandaard BRP
- name: provinceId
in: query
type: string
required: false
x-example: "1"
description: Filteren op identifier van de gemeente, gelijk aan die van de overheidstandaard BRP
- name: wgs84
in: query
type: string
required: false
x-example: 51.8463989,5.8031914
description: Komma gescheiden lat/lon (GPS) coordinaten om te sorteren op afstand
responses:
200:
description: OK
schema:
type: object
required:
- data
- links
properties:
data:
type: array
items:
$ref: "#/definitions/Address"
links:
type: object
required:
- self
properties:
self:
type: string
example: https://api.postcodeapi.nu/v2/addresses?page=2
description: Link naar volgende pagina
prev:
type: string
example: https://api.postcodeapi.nu/v2/addresses?page=2
description: Link naar volgende pagina
next:
type: string
example: https://api.postcodeapi.nu/v2/addresses?page=2
description: Link naar volgende pagina
/addresses/{id}:
x-swagger-router-controller: address
get:
tags: [address]
summary: Enkel adres
operationId: findOneAddress
parameters:
- name: id
description: Identifier van het adres, gelijk aan die van de overheidstandaard BAG
in: path
type: string
required: true
x-example: "268200000075156"
- name: wgs84
in: query
type: string
required: false
x-example: 51.8463989,5.8031914
description: Komma gescheiden lat/lon (GPS) coordinaten om de afstand tot dit adres te berekenen
description: Informatie over een adres
responses:
200:
description: OK
schema:
type: object
required:
- data
properties:
data:
$ref: "#/definitions/Address"
/postcodes:
get:
tags: [postcode]
summary: Alle postcodes
description: Alle postcodes in Nederland, gepagineerd per 20 records
operationId: findPostcodes
parameters:
- name: page
in: query
type: integer
required: false
default: 1
x-example: 1
description: Paginanummer voor paginering
- name: postcodeArea
in: query
type: integer
required: false
x-example: 6545
description: Filteren op postcodegebied in *P4* formaat
- name: street
in: query
type: string
required: false
x-example: Binderskampweg
description: Filteren op straatnaam
- name: cityId
in: query
type: string
required: false
x-example: "268200000075156"
description: Filteren op identifier van de woonplaats, gelijk aan die van de overheidstandaard BAG
- name: municipalityId
in: query
type: string
required: false
x-example: "3030"
description: Filteren op identifier van de gemeente, gelijk aan die van de overheidstandaard BRP
- name: provinceId
in: query
type: string
required: false
x-example: "1"
description: Filteren op identifier van de provincie, gelijk aan die van de overheidstandaard BRP
- name: wgs84
in: query
type: string
required: false
x-example: 51.8463989,5.8031914
description: Komma gescheiden lat/lon (GPS) coordinaten om te sorteren op afstand
responses:
200:
description: OK
schema:
type: object
properties:
_embedded:
type: object
properties:
postcodes:
type: array
items:
type: object
properties:
postcode:
type: string
example: 6545CA
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: /postcodes/6545CA
description: Link naar postcode informatie
_links:
type: object
properties:
next:
type: object
properties:
href:
type: string
example: /postcodes?page=2
description: Link naar volgende pagina
/postcodes/{postcode}:
get:
tags: [postcode]
summary: Enkele postcode
operationId: findOnePostcode
parameters:
- name: postcode
in: path
type: string
required: true
x-example: 6545CA
description: Postcode in *P6* formaat
- name: wgs84
in: query
type: string
required: false
x-example: 51.8463989,5.8031914
description: Komma gescheiden lat/lon (GPS) coordinaten om de afstand tot deze postcode te berekenen
description: Informatie over een postcode met bijbehorende adressen
responses:
200:
description: OK
schema:
type: object
properties:
postcode:
type: string
example: 6545CA
description: Postcode
city:
$ref: "#/definitions/City"
municipality:
$ref: "#/definitions/Municipality"
province:
$ref: "#/definitions/Province"
streets:
type: array
example: [Binderskampweg, Kronenburgersingel]
description: Ontdubbelde straten die binnen deze postcode vallen
distance:
type: number
format: float
example: 23.1
description: Afstand (in km) tot WGS84 coordinaten als deze zijn opgegeven
geo:
type: object
properties:
center:
type: object
properties:
wgs84:
$ref: "#/definitions/Wgs84Center"
rd:
$ref: "#/definitions/RdCenter"
addresses:
type: array
items:
type: object
properties:
street:
type: string
example: Binderskampweg
description: Straat
number:
type: integer
example: 29
description: Huisnummer
letter:
type: string
example: U
description: Letter
addition:
type: string
example: "31"
description: Huisnummer toevoeging
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: /addresses/268200000075156
description: Link naar adres informatie
_links:
type: object
properties:
city:
type: object
properties:
href:
type: string
example: https://api.plaatsapi.nu/cities/3030
description: Link naar woonplaats informatie van Plaats API
municipality:
type: object
properties:
href:
type: string
example: https://api.plaatsapi.nu/municipalities/01268
description: Link naar gemeente informatie van Plaats API
province:
type: object
properties:
href:
type: string
example: https://api.plaatsapi.nu/provinces/1
description: Link naar provincie informatie van Plaats API
/postcode-areas:
get:
tags: [postcode-area]
summary: Alle postcodegebieden
description: Alle postcodegebieden in Nederland, gepagineerd per 20 records
parameters:
- name: page
in: query
type: integer
required: false
default: 1
x-example: 1
description: Paginanummer voor paginering
responses:
200:
description: OK
schema:
type: object
properties:
_embedded:
type: array
items:
type: object
properties:
label:
type: string
example: 6545
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: /postcode-areas/6545
_links:
type: object
properties:
next:
type: object
properties:
href:
type: string
example: /postcode-areas?page=2
/postcode-areas/{postcodeArea}:
get:
tags: [postcode-area]
summary: Enkel postcodegebied
parameters:
- name: postcodeArea
in: path
type: string
required: true
x-example: 6545
description: Postcodegebied in *P4* formaat
- name: wgs84
in: query
type: string
required: false
x-example: 51.8463989,5.8031914
description: Komma gescheiden lat/lon (GPS) coordinaten om de afstand tot dit postcodegebied te berekenen
description: Informatie over een postcodegebied met bijbehorende postcodes
responses:
200:
description: OK
schema:
type: object
properties:
postcodeArea:
type: string
example: 6545
description: Postodegebied
city:
$ref: "#/definitions/City"
municipality:
$ref: "#/definitions/Municipality"
province:
$ref: "#/definitions/Province"
geo:
type: object
properties:
center:
type: object
properties:
rd:
$ref: "#/definitions/RdCenter"
wgs84:
$ref: "#/definitions/Wgs84Center"
postcodes:
type: array
items:
type: object
properties:
label:
type: string
example: 6545CA
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: /postcodes/6545CA
_links:
type: object
properties:
addresses:
type: object
properties:
href:
type: string
example: /addresses?postcodeArea=6545
postcodes:
type: object
properties:
href:
type: string
example: /postcodes?postcodeArea=6545
city:
type: object
properties:
href:
type: object
example: https://api.plaatsapi.nu/cities/3030
description: Link naar woonplaats informatie van Plaats API
municipality:
type: object
properties:
href:
type: object
example: https://api.plaatsapi.nu/municipalities/01268
description: Link naar gemeente informatie van Plaats API
province:
type: object
properties:
href:
type: object
example: https://api.plaatsapi.nu/provinces/1
description: Link naar provincie informatie van Plaats API
definitions:
Address:
type: object
required:
- type
- id
- attributes
properties:
type:
type: string
example: "addresses"
id:
type: string
example: "268200000075156"
description: Identifier van het adres, gelijk aan die van de BAG
attributes:
type: object
required:
- street
- number
- letter
- addition
- postcode
- geo
- type
- purpose
properties:
street:
type: string
example: Binderskampweg
description: Straat
number:
type: integer
example: 29
description: Huisnummer
letter:
type: [ string, "null" ]
example: U
description: Letter
addition:
type: [ string, "null" ]
example: "31"
description: Huisnummer toevoeging
postcode:
type: [ string, "null" ]
example: 6545CA
description: Postcode in *P6* formaat
distance:
type: [ number ]
format: float
example: 23.1
description: Afstand (in km) tot WGS84 coordinaten als deze zijn opgegeven
geo:
type: object
properties:
center:
type: object
properties:
wgs84:
$ref: "#/definitions/Wgs84Center"
rd:
$ref: "#/definitions/RdCenter"
type:
type: string
example: Verblijfsobject
description: Type gebouw
purpose:
type: [ string, "null" ]
example: woonfunctie
description: Gebruiksdoel
links:
type: object
required:
- self
properties:
self:
type: string
example: https://api.postcodeapi.nu/v2/addresses/268200000075156
description: Link naar het adres
Province:
type: object
properties:
id:
type: string
example: "1"
description: Identifier van de provincie, gelijk aan die van de overheidstandaard BRP
label:
type: string
example: Gelderland
description: Provincie
Municipality:
type: object
properties:
id:
type: string
example: "3030"
description: Identifier van de gemeente, gelijk aan die van de overheidstandaard BRP
label:
type: string
example: Nijmegen
description: Gemeente
City:
type: object
properties:
id:
type: string
example: "1"
description: Identifier van de woonplaats, gelijk aan die van de overheidstandaard BAG
label:
type: string
example: Nijmegen
description: Woonplaats
Wgs84Center:
type: object
properties:
type:
type: string
example: Point
coordinates:
type: array
items:
type: number
example: [6.861053257304809, 53.32271304611565]
crs:
type: object
properties:
type:
type: string
example: name
properties:
type: object
properties:
name:
type: string
example: urn:ogc:def:crs:OGC:1.3:CRS84
RdCenter:
type: object
properties:
type:
type: string
example: Point
coordinates:
type: array
items:
type: number
example: [253207, 593924]
crs:
type: object
properties:
type:
type: string
example: name
properties:
type: object
properties:
name:
type: string
example: urn:ogc:def:crs:EPSG::28992