Sich authentifizieren

Es ist äußerst wichtig, dass Sie der Plattform mitteilen, wer Sie sind, wenn Sie Anforderungen an die API senden. Ansonsten werden Sie als anonymer Benutzer behandelt und verlieren somit besondere Zugriffsrechte, die Sie für Portale oder Datensätze erhalten haben.

Damit die Plattform weiß, wer Sie sind, müssen Sie:

  • entweder bei einem Portal eingeloggt sein und Anfragen vom Portal aus über das Portal machen (z. B. mithilfe der Konsole)

  • oder einen API-Schlüssel mit Ihren Anforderungen bereitstellen, der Sie eindeutig identifiziert.

Finden und Generieren von API-Schlüsseln

Um die Liste Ihrer API-Schlüssel zu sehen, wechseln Sie zur Profilseite auf http://<youropendatasoftportal>.com/account/ (oder durch Klicken auf Ihren Namen in der Überschrift).

Wechseln Sie auf der Profilseite zum Register namens Meine API-Schlüssel, um die Liste Ihrer aktiven Schlüssel anzuzeigen, sie zu sperren oder neue zu erstellen.

Wichtig

Sie können so viele Schlüssel haben, wie Sie möchten, sie identifizieren Sie alle auf die gleiche Weise. Das heißt, dass sie allen Personen, die sie verwenden, die gleichen Berechtigungen einräumen (nämlich Ihre). Deswegen sollten Sie Ihre Schlüssel nicht teilen.

Bereitstellen von API-Schlüsseln in Anforderungen

Jetzt, wo Sie einen API-Schlüssel haben, können Sie ihn zusammen mit Ihren Anforderungen durch den Anfrageparameter apikey übermitteln.

Zur Veranschaulichung dessen nehmen wir einmal an, dass Sie ein privates Portal eingerichtet haben und die Liste der Datensätze von einer externen Anwendung, die Sie erstellen, abrufen möchten.

Wenn Ihre Anwendung folgenden Aufruf startet:

http://myprivateportal.opendatasoft.com/api/v2/catalog/datasets/

Sie werden die Fehlermeldung 403 Verboten erhalten.

Starten Sie hingegen folgenden Aufruf:

http://myprivateportal.opendatasoft.com/api/v2/catalog/datasets/?apikey=<myapikey>

Sie werden eine JSON (JavaScript Object Notation) mit der vollständigen Liste der auf dem Portal verfügbaren Datensätze erhalten.