API-Dienste: Unterschied zwischen den Versionen
| Zeile 7: | Zeile 7: | ||
=== Zugangsbeschränkung === | === Zugangsbeschränkung === | ||
| − | Zum Abruf von Personen- und Körperschaftsdatensätzen wird ein Zugangsschlüssel (API Key) benötigt. Dieser wird im Rahmen von Kooperationsvereinbarungen durch die Digitale Abteilung des DFF zugeteilt. | + | Zum Abruf von Personen- und Körperschaftsdatensätzen wird ein Zugangsschlüssel (API Key) benötigt. Dieser wird im Rahmen von Kooperationsvereinbarungen durch die Digitale Abteilung des DFF zugeteilt. Die in den nachfolgenden Beispielen verwendeten Zugangsschlüssel sind nicht gültig und müssen für den Gebrauch durch einen gültigen Schlüssel ersetzt werden. |
Alle hier dokumentierten Aufrufe können auf eine der folgenden Arten autorisiert werden: | Alle hier dokumentierten Aufrufe können auf eine der folgenden Arten autorisiert werden: | ||
| Zeile 13: | Zeile 13: | ||
* 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 autimatisierte Abfragen. | ||
| − | <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1&</nowiki>'''apikey=DE61ZABMMjBj''' | + | <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1&</nowiki>'''apikey=<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: | * 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: | ||
| − | curl '''-H "Apikey: DE61ZABMMjBj"''' <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1</nowiki> | + | curl '''-H "Apikey: <span style="color:brown">DE61ZABMMjBj</span>"''' <nowiki>https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1</nowiki> |
=== Basis-URL === | === Basis-URL === | ||
Version vom 27. April 2022, 12:36 Uhr
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.
Personen- und Körperschaftsdaten aus der DFF-ZDB
Zugangsbeschränkung
Zum Abruf von Personen- und Körperschaftsdatensätzen wird ein Zugangsschlüssel (API Key) benötigt. Dieser wird im Rahmen von Kooperationsvereinbarungen durch die Digitale Abteilung des DFF zugeteilt. Die in den nachfolgenden Beispielen verwendeten Zugangsschlüssel sind nicht gültig und müssen für den Gebrauch durch einen gültigen Schlüssel ersetzt werden.
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.
https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1&apikey=DE61ZABMMjBj
- 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:
curl -H "Apikey: DE61ZABMMjBj" https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7?s=eac&xd=1
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:
https://ws.dff.film/zdb/p/489BF7038FAE48578CDBC01F2771A5B7 für einen Personen-Datensatz
