OSIRIS 2.0 Methodenthesaurus Web Service API Version 1.0

Dokumentation der OSIRIS 2.0 Methodenthesaurus REST Web Service API Version 1.0

Version: 1.0.1

Copyright: © 2013 LANUV NRW

Aktualisierungsdatum: 13.12.2013

Verzeichnis

Allgemeines

Zeichenkodierung

Die REST-Schnittstelle antwortet in der Kodierung UTF-8.

Formate

Die REST-Schnittstelle beantwortet Anfragen in den Formaten XML, JSON oder JavaScript.

XML

Eine Antwort in XML kann für jede Anfrage an die REST-Schnittstelle über den URL-Parameter format und die Wertzuweisung xml angefordert werden. Geantwortet wird hieraufhin mit Content-Type: text/xml; charset=utf-8.

JSON

JSON ist das Standardausgabeformat der REST-Schnittstelle. Standardgemäss antwortet die Schnittstelle in Content-Type: application/json; charset=utf-8.

JavaScript

Die REST-Schnittstelle gibt für in JSON with padding (JSONP) angeforderte Antworten JavaScript zurück. Die Anforderung erfolgt über den URL-Parameter callback in dem der gewünschte Methodenname eingetragen wird. Beantwortet wird diese Anfrage mit Content-Type: application/javascript; charset=utf-8.

Authentifizierung für zugriffsbeschränkte Anfragen

Eine Authentisierung der REST-Schnittstelle erfolgt einheitlich für die Methoden GET, POST, PUT und DELETE. Zusätzlich zur jeweiligen Anfrage ist hierfür der Header X-Auth-Token erforderlich, Platzhalter für den Zugriffsschlüssel.

Der Zugriffsschlüssel zur Verwendung in X-Auth-Token kann über die angegebene Kontaktadresse bezogen werden.

Vorlage: Authentifizierte GET Anfrage HTTP GET JSON Mit Authentifizierung
GET /methoden/api/v1/osiris.bemerkungen HTTP/1.1
Host: methoden.api.naturschutzinformationen.nrw.de 
X-Auth-Token: pndVpURTRaREkz

Eine authentifizierte Anfrage mittels cURL
Beispiel: Authentifizierte GET Anfrage über Kommandozeile mittels cURL cURL HTTP GET JSON Mit Authentifizierung
curl -H "X-Auth-Token: pndVpURTRaREkz" -X GET http://methoden.api.naturschutzinformationen.nrw.de/methoden/api/v1/osiris.bemerkungen

Eine authentifizierte Anfrage in JavaScript
Beispiel: Authentifizierte GET Anfrage in JavaScript / jQuery jQuery HTTP GET JavaScript (JSONP) Mit Authentifizierung
jQuery.ajax({type: 'GET', url: 'http://methoden.api.naturschutzinformationen.nrw.de/methoden/api/v1/osiris.bemerkungen',
beforeSend: function(xhr, settings) { 
  xhr.setRequestHeader('X-Auth-Token', 'pndVpURTRaREkz'); 
}, dataType: 'jsonp', success: function(contents) { … }});

Eine authentifizierte Anfrage in Python
Beispiel: Authentifizierte GET Anfrage in Python Python HTTP GET JSON Mit Authentifizierung
import urllib2
request = urllib2.Request("http://methoden.api.naturschutzinformationen.nrw.de/methoden/api/v1/osiris.bemerkungen", headers={"X-Auth-Token": "pndVpURTRaREkz"})
contents = urllib2.urlopen(request).read()

Eine authentifizierte Anfrage in PHP
Beispiel: Authentifizierte GET Anfrage in PHP PHP HTTP GET JSON Mit Authentifizierung
$contents = file_get_contents( 'http://methoden.api.naturschutzinformationen.nrw.de/methoden/api/v1/osiris.bemerkungen', false, stream_context_create( array( 'http' => array(
  'method' => 'GET',
  'header' => Array('X-Auth-Token: pndVpURTRaREkz')
))));

Eine authentifizierte Anfrage in ASP.NET
Beispiel: Authentifizierte GET Anfrage in ASP.NET ASP.NET HTTP GET JSON Mit Authentifizierung
System.Net.WebClient request = new System.Net.WebClient();
request.Headers.Add( "X-Auth-Token", "pndVpURTRaREkz" );
var contents = request.DownloadString( "http://methoden.api.naturschutzinformationen.nrw.de/methoden/api/v1/osiris.bemerkungen" );

REST Web-Services

Allgemeine Definition von Abfragen auf Tabellen und Views

Schnittstellen: http://methoden.api.naturschutzinformationen.nrw.de/methoden/api/v1/<SCHEMA>.<TABLE_OR_VIEW>

Zugriffsverwaltung

Im aktuellen Aufsatz sind die Abfragen auf Tabellen und Views auch für nicht authentisierte Anfragesteller in vollem Umfung nutzbar.

Methoden: optionaler Header (für Authentifizierung): Parameter: Antwort:

Copyright © 2013 LANUV NRW