download_from_api_brk

Download from the BRK API from api.data.amsterdam.nl using the OAuth2 datapunt Authorization service with employee_plus credentials.

Use ENV:

export DATAPUNT_EMAIL=***
export DATAPUNT_PASSWORD=***

Command line example:

download_from_api_brk https://api.data.amsterdam.nl/brk/object/ BRK/RS,BRK/RSN,BRK/RO data object.json

usage: download_from_api_brk [-h] url scopes output_folder filename

Positional Arguments

url	add full endpoint, for example: https://api.data.amsterdam.nl/brk/object/
scopes	Choose scopes, the names can be found here: https://github.com/Amsterdam/authorization_levels/blob/master/authorization_levels.py. For example: TLLS/R or multiple: BRK/RS,BRK/RSN,BRK/RO
output_folder	add outputfolder location, for example: my_project_folder/data
filename	add filename for example brk.json

functions

datapunt_processing.extract.download_from_api_brk.getJsonData(url, accessToken)

Get a json response from a url with accesstoken.

Args:

1. url: api endpoint

2. accessToken: acces token generated using the auth helper: GetAccessToken().getAccessToken(usertype=’employee_plus’,

   scopes=’BRK/RS,BRK/RSN/,BRK/RO’)

Returns:

parsed json or error message

datapunt_processing.extract.download_from_api_brk.parser()

Parser function to run arguments from commandline and to add description to sphinx docs.