API-Dienste - Versionsgeschichte

Dbalzer am 30. April 2022 um 11:35 Uhr

2022-04-30T11:35:23Z

Dbalzer am 30. April 2022 um 11:28 Uhr

2022-04-30T11:28:26Z

Dbalzer am 30. April 2022 um 11:24 Uhr

2022-04-30T11:24:43Z

Dbalzer am 30. April 2022 um 09:31 Uhr

2022-04-30T09:31:23Z

Dbalzer: /* Zugangsbeschränkung */

2022-04-30T08:59:45Z

‎Zugangsbeschränkung

Dbalzer: /* Zugangsbeschränkung */

2022-04-30T08:54:35Z

‎Zugangsbeschränkung

Dbalzer am 30. April 2022 um 07:20 Uhr

2022-04-30T07:20:31Z

Dbalzer am 30. April 2022 um 07:13 Uhr

2022-04-30T07:13:45Z

Dbalzer am 27. April 2022 um 16:49 Uhr

2022-04-27T16:49:13Z

Dbalzer am 27. April 2022 um 16:45 Uhr

2022-04-27T16:45:09Z

@@ Zeile 3: / Zeile 3: @@
 Der Zugang erfolgt über die Subdomain '''''ws.dff.film''''', mit Ausnahme der Dienste, die das Protokoll OAI-PMH  ''(Open Archive Initiative Protocol for Metadata Harvesting)'' verwenden. Für letztere gibt es die Subdomain [[OAI-Dienst|'''''oai.dff.film''''']].
-* [[ZDB-Entitäten-API]] - Eine Schnittstelle zum Abruf von einzelnen Instanzen aus der ZDB in unterschiedlichen Datenformaten.
+* '''[[ZDB-Entitäten-API]]''' - Eine Schnittstelle zum Abruf von einzelnen Instanzen aus der ZDB in unterschiedlichen Datenformaten.
-* [[UID-Listen]] - Listen mit Identifikatoren (UIDs) von Untermengen des ZDB-Datenbestandes
+* '''[[UID-Listen]]''' - Listen mit Identifikatoren (UIDs) von Untermengen des ZDB-Datenbestandes

@@ Zeile 1: / Zeile 1: @@
 APIs ''(Application Program Interfaces)'' werden für die programmgestützte Nutzung bereitgestellt. Hierüber können Kooperationspartner des DFF mit ihren Anwendungsprogrammen Daten aus dem Bestand der ZDB abrufen.
-Der Zugang erfolgt über die Subdomain '''''ws.dff.film''''', mit Ausnahme der Dienste, die das Protokoll OAI-PMH  ''(Open Archive Initiative Protocol for Metadata Harvesting)'' verwenden. Für letztere gibt es die Subdomain '''''oai.dff.film'''''.
+Der Zugang erfolgt über die Subdomain '''''ws.dff.film''''', mit Ausnahme der Dienste, die das Protokoll OAI-PMH  ''(Open Archive Initiative Protocol for Metadata Harvesting)'' verwenden. Für letztere gibt es die Subdomain [[OAI-Dienst|'''''oai.dff.film''''']].
 * [[ZDB-Entitäten-API]] - Eine Schnittstelle zum Abruf von einzelnen Instanzen aus der ZDB in unterschiedlichen Datenformaten.
 * [[UID-Listen]] - Listen mit Identifikatoren (UIDs) von Untermengen des ZDB-Datenbestandes

@@ Zeile 3: / Zeile 3: @@
 Der Zugang erfolgt über die Subdomain '''''ws.dff.film''''', mit Ausnahme der Dienste, die das Protokoll OAI-PMH  ''(Open Archive Initiative Protocol for Metadata Harvesting)'' verwenden. Für letztere gibt es die Subdomain '''''oai.dff.film'''''.
-== ZDB-Entitäten-API ==
+* [[ZDB-Entitäten-API]] - Eine Schnittstelle zum Abruf von einzelnen Instanzen aus der ZDB in unterschiedlichen Datenformaten.
-Eine Schnittstelle zum Abruf von einzelnen Instanzen aus der ZDB in unterschiedlichen Datenformaten.
+* [[UID-Listen]] - Listen mit Identifikatoren (UIDs) von Untermengen des ZDB-Datenbestandes

← Nächstältere Version		Version vom 30. April 2022, 09:31 Uhr
Zeile 58:		Zeile 58:

	* '''s''' - das Datenschema und -format, in dem die angeforderten Daten geliefert werden sollen. Für Filmwerke sind dies		* '''s''' - das Datenschema und -format, in dem die angeforderten Daten geliefert werden sollen. Für Filmwerke sind dies
		+
		+	:: '''dif-n''' - Das native XML-Format für Filmwerke der ZDB in der Version 1.4.
		+
		+	:: '''dif-n1.5''' - Das native XML-Format für Filmwerke der ZDB in der Version 1.5. Reihen- und Gesamttitel werden hier zu einer Entität "Aggregatwerk".
		+
		+	:: '''forward''' - XML-Filmwerks-Schema für das ehemalige Projekt FORWARD.
		+
		+	* '''xd''' - Nur für XML-basierte Formate: Voranstellen einer Präambel mit XML ''processing instruction'' und der Schema-Referenz. Boolesches Attribut mit den Werten 0 (nein) und 1 (ja).
		+
		+	:: '''0''' - Ohne Präambel, d.h. reine XML-Daten ab dem Wurzelement für den Datensatz. Geeignet für Mehrfach-Abfragen, deren Ergebnisse beim Client zu einem XML-Dokument zusammengeführt werden sollen.
		+
		+	:: '''1''' - Mit Präambel. Geeignet für Abfragen, die einzeln mit XML-Werkzeugen verarbeitet werden sollen.
		+
		+	* '''api_key''' - Autorisierungsschlüssel als Aufrufparameter. Wird benötigt, wenn der Autorisierungsschlüssel nicht im HTTP-Header angegeben ist.
		+

	=== Beispiele für die Entitäten-API ===		=== Beispiele für die Entitäten-API ===

@@ Zeile 15: / Zeile 15: @@
 * Durch Angabe eines URL-Parameters "api_key" mit dem Schlüssel als Wert. Diese Variante eignet sich sowohl für Aufrufe aus einem Web-Browser wie auch für automatisierte Abfragen.
-   <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1&</nowiki>'''apikey=<span style="color:brown">DE61ZABMMjBj</span>'''
+   <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1&</nowiki>'''api_key=<span style="color:brown">DE61ZABMMjBj</span>'''
 * Durch Angabe eines HTTP-Headers "Apikey" mit dem Schlüssel als Wert. Diese Variante eignet sich vorrangig für automatisierte Abfragen durch Client-Programme. Mit einem Kommendozeilen-Werkzeug wie curl sieht eine solche Abfrage folgendermaßen aus:

@@ Zeile 13: / Zeile 13: @@
 Alle hier dokumentierten Aufrufe können auf eine der folgenden Arten autorisiert werden:
-* Durch Angabe eines URL-Parameters "api_key" mit dem Schlüssel als Wert. Diese Variante eignet sich sowohl für Aufrufe aus einem Web-Browser wie auch für autimatisierte Abfragen.
+* Durch Angabe eines URL-Parameters "api_key" mit dem Schlüssel als Wert. Diese Variante eignet sich sowohl für Aufrufe aus einem Web-Browser wie auch für automatisierte Abfragen.
    <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1&</nowiki>'''apikey=<span style="color:brown">DE61ZABMMjBj</span>'''

@@ Zeile 23: / Zeile 23: @@
 === Basis-URL ===
-Alle Aufrufe haben die Basis-Adresse https://ws.dff.film/zdb/ . Für die Entität "Person" folgt das Kürzel "p" und für Körperschaften das Kürzel "ks", gefolgt vom UID des gewünschten Datensatzes:
+Alle Aufrufe haben die Basis-Adresse https://ws.dff.film/zdb/ . Für die Entität "Person" folgt das Kürzel "p", für Körperschaften "ks" und für Filmwerke "fw", gefolgt vom UID des gewünschten Datensatzes:
 <code><nowiki>https://ws.dff.film/zdb/</nowiki>'''p'''/489BF7038FAE48578CDBC01F2771A5B7</code> für einen Personen-Datensatz
@@ Zeile 31: / Zeile 31: @@
 === Aufrufparameter ===
-In den meisten Fällen wird es nötig sein, einen oder mehrere der folgenden Aufrufparameter, angehängt als Optionen an den Basis-URL zu verwenden:
+In den meisten Fällen wird es nötig sein, einen oder mehrere der folgenden Aufrufparameter als angehängte Option(en) zum Basis-URL zu verwenden:
 ==== Personen und Körperschaften ====
@@ Zeile 45: / Zeile 45: @@
 * '''xd''' - Nur für XML-basierte Formate: Voranstellen einer Präambel mit XML ''processing instruction'' und der Schema-Referenz. Boolesches Attribut mit den Werten 0 (nein) und 1 (ja).
-:: '''0''' - Keine Präambel, sondern reine XML-Daten ab dem Wurzelement für den Datensatz. Geeignet für Mehrfach-Abfragen, deren Ergebnisse zu einem XML-Dokument zusammengeführt werden sollen.
+:: '''0''' - Ohne Präambel, d.h. reine XML-Daten ab dem Wurzelement für den Datensatz. Geeignet für Mehrfach-Abfragen, deren Ergebnisse beim Client zu einem XML-Dokument zusammengeführt werden sollen.
 :: '''1''' - Mit Präambel. Geeignet für Abfragen, die einzeln mit XML-Werkzeugen verarbeitet werden sollen.
@@ Zeile 54: / Zeile 54: @@
 * '''api_key''' - Autorisierungsschlüssel als Aufrufparameter. Wird benötigt, wenn der Autorisierungsschlüssel nicht im HTTP-Header angegeben ist.

@@ Zeile 31: / Zeile 31: @@
 In den meisten Fällen wird es nötig sein, einen oder mehrere der folgenden Aufrufparameter zu verwenden:
-   '''s''' - das Datenschema und  -format, in dem die angeforderten Daten geliefert werden sollen. Für Personen und Körperschaften sind dies
+* '''s''' - das Datenschema und  -format, in dem die angeforderten Daten geliefert werden sollen. Für Personen und Körperschaften sind dies
 :: '''eac''' - ''[https://eac.staatsbibliothek-berlin.de/ Encoded Archival Context for Corporate Bodies, Persons, and Families]''. Ein geringfügig modifiziertes XML-Schema von der Gemeinschaft der Archivare.
@@ Zeile 39: / Zeile 39: @@
 :: '''dnb_json''' - JSON-Format, wie für die Datenübertragung an die GND verwendet.
-   '''xd''' - Nur für XML-basierte Formate: Voranstellen einer Präambel mit XML ''processing instruction'' und der Schema-Referenz. Boolesches Attribut mit den Werten 0 (nein) und 1 (ja).
+* '''xd''' - Nur für XML-basierte Formate: Voranstellen einer Präambel mit XML ''processing instruction'' und der Schema-Referenz. Boolesches Attribut mit den Werten 0 (nein) und 1 (ja).
 :: '''0''' - Keine Präambel, sondern reine XML-Daten ab dem Wurzelement für den Datensatz. Geeignet für Mehrfach-Abfragen, deren Ergebnisse zu einem XML-Dokument zusammengeführt werden sollen.
@@ Zeile 45: / Zeile 45: @@
 :: '''1''' - Mit Präambel. Geeignet für Abfragen, die einzeln mit XML-Werkzeugen verarbeitet werden sollen.
-   '''add''' - Einbeziehen von verknüpften Entitäten. Derzeit nur verfügbar für Personen-Datensätze im EAC-XML-Format.
+* '''add''' - Einbeziehen von verknüpften Entitäten. Derzeit nur verfügbar für Personen-Datensätze im EAC-XML-Format.
 :: '''FW''' - Verknüpfte Filmwerke mit Angabe der Funktion bzw. Rolle werden in Kurzdarstellung an den Personen-Datensatz angefügt.
-   '''api_key''' - Autorisierungsschlüssel als Aufrufparameter. Wird benötigt, wenn der Autorisierungsschlüssel nicht im HTTP-Header angegeben ist.
+* '''api_key''' - Autorisierungsschlüssel als Aufrufparameter. Wird benötigt, wenn der Autorisierungsschlüssel nicht im HTTP-Header angegeben ist.