Technische Aspekte

Bei der Entwicklung einer Anwendung, welche die "Public Value API" nutzt, sind einige Punkte zu berücksichtigen.

API Key

Übertragen Sie den API Key im Header x-api-key.

Bezirke nicht hard-kodieren

Da sich die Liste der Bezirke in Zukunft ändern kann, sollte sie immer vom Endpunkt /districts geladen und nicht statisch in Ihrer Anwendung hinterlegt werden.

Sonderzeichen

Sonderzeichen in URL-Parametern müssen URL-kodiert sein. Zum Beispiel muss bei Abfrage von /services der Wert "Düsseldorf" als D%C3%BCsseldorf kodiert sein: /services?district=D%C3%BCsseldorf.

Weitere Information:

• Wikipedia-Artikel "URL-Encoding"
• MDN-Seite "encodeURIComponent()"

CORS

Die API unterstützt CORS, wobei jeder Origin zulässig ist. Somit kann die API auch problemlos in Browser-basierten Anwendungen genutzt werden.

Weitere Information:

• MDN-Seite "Cross-Origin Resource Sharing (CORS)"

Caching

Der Server speichert die Antworten einige Zeit im Cache. Die Cache-Dauer entspricht dem Wert von max-age bzw. s-maxage im Response-Header Cache-Control. Bei der Entwicklung einer Anwendung, ist es sinnvoll die API-Response für eine vergleichbare Dauer zu cachen.

Die Cache-Control-Header-Werte der unterschiedlichen Endpunkte finden Sie in der herunterladbaren API-Spezifikation unter Endpunkte.

Weitere information:

• MDN-Seite "Cache-Control"