API-Referenz

Die JudaicaLink-API bietet programmatischen Zugriff auf verknüpfte Daten, einschließlich Entitäten, Datensätzen und SPARQL-Abfragen. Dieser Leitfaden beschreibt verfügbare API-Endpunkte.

Basis-URL der API: https://data.judaicalink.org/api/

Authentifizierung

Derzeit ist die JudaicaLink-API öffentlich zugänglich und erfordert keine Authentifizierung.

Endpunkte

1. Entitätsdaten abrufen

Endpunkt:

GET /entity/{id}

Beschreibung: Ruft strukturierte RDF-Daten zu einer bestimmten Entität ab.

Beispielanfrage:

GET https://data.judaicalink.org/api/entity/moses-mendelssohn

Antwort (JSON-LD-Beispiel):

{
    "@context": "https://schema.org",
    "@id": "https://data.judaicalink.org/entity/moses-mendelssohn",
    "@type": "Person",
    "name": "Moses Mendelssohn",
    "birthDate": "1729-09-06",
    "deathDate": "1786-01-04"
}

2. Entitäten suchen

Endpunkt:

GET /search

Beschreibung: Führt eine Volltextsuche über den Wissensgraphen von JudaicaLink durch.

Parameter:

q (erforderlich) - Suchbegriff
limit (optional, Standardwert: 10) - Anzahl der zurückzugebenden Ergebnisse

Beispielanfrage:

GET https://data.judaicalink.org/api/search?q=Mendelssohn&limit=5

3. Verfügbare Datensätze auflisten

Endpunkt:

GET /datasets

Beschreibung: Gibt Metadaten zu allen in JudaicaLink verfügbaren Datensätzen zurück.

Beispielanfrage:

GET https://data.judaicalink.org/api/datasets

Beispielantwort:

[
    {
        "id": "yivo",
        "title": "YIVO Encyclopedia",
        "description": "Jewish history and culture dataset"
    },
    {
        "id": "stolpersteine",
        "title": "Stolpersteine Memorials",
        "description": "Database of Holocaust memorials in Europe"
    }
]

4. SPARQL-Abfragen ausführen

Endpunkt:

GET /sparql

Beschreibung: Führt eine SPARQL-Abfrage im Wissensgraphen von JudaicaLink aus.

Parameter:

query (erforderlich) - SPARQL-Abfragezeichenfolge

Beispielanfrage:

GET https://data.judaicalink.org/api/sparql?query=SELECT+%3Fperson+%3Fname+WHERE+%7B+%3Fperson+a+foaf%3APerson+%3B+foaf%3Aname+%3Fname+%7D+LIMIT+10

Antwortformat: - JSON (Accept: application/json) - XML (Accept: application/xml)

Fehlerbehandlung

Die API gibt Standard-HTTP-Statuscodes zurück:

200 OK - Erfolgreiche Anfrage
400 Bad Request - Ungültige Parameter
404 Not Found - Ressource existiert nicht
500 Internal Server Error - Serverseitiges Problem

Nutzungslimits und bewährte Verfahren

Ratenbegrenzungen: Die API setzt Anforderungslimits durch, um Missbrauch zu verhindern. Wenn Sie eine 429 Too Many Requests-Antwort erhalten, reduzieren Sie die Anforderungshäufigkeit.
Effiziente Abfragen: Verwenden Sie Filter und LIMIT-Klauseln in SPARQL-Abfragen, um die Antwortzeiten zu verbessern.
Daten-Caching: Cachen Sie häufig abgerufene Ergebnisse, um die Belastung der API zu reduzieren.

Unterstützung

Für Unterstützung kontaktieren Sie: https://labs.judaicalink.org/contact/.

— Die JudaicaLink-API bietet strukturierte, verknüpfte Daten für jüdische Studien. Erkunden Sie die Datensätze und integrieren Sie sie in Ihre Projekte! 🚀