Python
Leestijd: 2 MinutenDit jaar wil ik elke maand iets maken. Een stuk code, een soldeer project, iets in de tuin of huis. Het doel is om het af te krijgen in die maand en daar de focus op te leggen. Afgelopen maand ben ik bezig geweest mijn Python skills verder uit te breiden. Wat ik graag wou ik een REST API maken waar je een postcode mee kan raadplegen. Bijvoorbeeld een GET naar /api/v1/zipcode/1011PN/1 geeft als resultaat het telefoon nummer en verdere informatie over dat postcode. En de beveiliging moest gedaan worden door middel val een key wat je mee gaf in de header.
Voordat ik kon beginnen heb ik onderzoek gedaan hoe ik het ging maken. Python heeft vele frameworks wat dit voor je kan doen. Op de vraag welke framework het beste is kan ik je geen antwoord geven maar welke spreekt mij het meest aan, En past het meest bij mijn wensen. Één van mijn eisen was een API key mee sturen in de header in plaats van wat je veel ziet een username en password meesturen.
Uiteindelijk ben ik gegaan voor het framework FLASK, mede door de decorators hoe je een REST functie kan definiëren.
|
1 2 3 4 |
@app.route('/api/v1/zipcode/<zipcode>/<number>', methods=['GET']) @auth.login_required def get_zipcode_number(zipcode,number): # Je code |
Het zoeken naar hoe je een API key meestuurt in je header kwam steeds uit op de volgende website. Maar zo wou ik het niet, deze persoon misbruikt het username en password veld om een API key mee te sturen. Hoe ik dat deel zelf heb gemaakt lees je hieronder.
Door de decorator @auth.login_required toe te voegen aan je functie wordt er gekeken of je de header Authorization hebt gedefinieerd. Mocht dit niet zo zijn dan wordt er een error getriggerd.
|
1 2 3 |
if 'Authorization' not in request.headers: request.data return self.auth_error_callback() |
Wanneer deze header er wel is wordt de authenticate callback aangeroepen.
|
1 2 3 4 |
token = request.headers['Authorization'] if self.authenticate_callback(token) is False: request.data return self.auth_error_callback() |
Deze callbacks definieer je in je applicatie zelf. In onderstaande voorbeeld haal ik de token/key uit een MySQL database.
|
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 |
class Token(Base): __tablename__ = 'token' id = Column(Integer, primary_key=True) token = Column(String) def __repr__(self): return "<Token(token='%s')>" % (self.token) app = Flask(__name__) auth = TokenAuth() @auth.authenticate def authenticate(token): filter = {'token': token} query = session.query(Token).filter_by(**filter) if (query.first() is None): return False return True engine = create_engine('mysql+pymysql://user:password#@host/zipcode?charset=utf8', echo=True) if __name__ == '__main__': Session = sessionmaker(bind=engine) session = Session() app.run(debug=False) |
Zie mijn Github voor de volledige code;