30 Tage kostenfrei testen – Startet jetzt mit persönlicher Begleitung. So läuft die Testphase ab
Sheltra Preise
Hilfe-Center +
Blog

Integrationen & Schnittstellen

Gibt es eine API?

Ja: Es gibt eine öffentliche Schnittstelle für veröffentlichte Tierdaten. Sie steht mit dem kostenlosen Modul Tierschutz in allen Tarifen zur Verfügung. Eine API ist ein geregelter Weg, auf…

Ja: Es gibt eine öffentliche Schnittstelle für veröffentlichte Tierdaten. Sie steht mit dem kostenlosen Modul Tierschutz in allen Tarifen zur Verfügung.

Eine API ist ein geregelter Weg, auf dem Programme Daten austauschen. Eure Website kann darüber die freigegebenen Tiere aus Sheltra abrufen. Eine allgemeine Schnittstelle zum Lesen oder Ändern sämtlicher Vereinsdaten ist das nicht.

„Unsere Website soll die Tierliste übernehmen“

Öffne mit Administrationsrechten Einstellungen → Öffentliche API. Unter Öffentliche URLs findest du die Adressen Tierliste, Tier-Detail und Tierbild. Das Kürzel eures Vereins ist bereits eingesetzt.

Gib diese Adressen und die Beispiele aus der Dokumentation an die Person weiter, die eure Website betreut. Sie richtet dort den Abruf und die Darstellung ein. Anschließend müsst ihr die freigegebenen Tierangaben nicht noch einmal separat auf der Website pflegen.

Wie schnell eine Änderung auf eurer Website erscheint, hängt von deren Abruf- und Zwischenspeicherung ab. Die Website wird nicht automatisch bei jeder Änderung von Sheltra benachrichtigt.

Welche Daten werden öffentlich?

Unter Sichtbare Felder entscheidest du, welche Angaben ausgegeben werden dürfen. Am einzelnen Tier muss Veröffentlicht gesetzt sein. Zusätzliche Regeln schließen beispielsweise verstorbene, deaktivierte oder bereits endgültig vermittelte Tiere aus.

Für den Abruf ist keine Anmeldung erforderlich. Prüfe deshalb die Freigaben bewusst, insbesondere bei Bildern oder Angaben zu Personen. Interne Notizen sollen nicht versehentlich in einer öffentlichen Darstellung landen.

Die einzelnen Freigaben erklärt Kann ich Inhalte öffentlich teilen?.

„Kann ein anderes Programm interne Daten lesen oder ändern?“

Über diese öffentliche API nicht. Personen, interne Dokumente, Vermittlungen und Buchhaltungsdaten werden nicht als allgemeine externe Schnittstelle bereitgestellt. Ebenso können darüber keine Datensätze in Sheltra angelegt oder bearbeitet werden.

Sheltra vergibt dafür keine eigenen API-Schlüssel oder technischen Konten. Mehr dazu: Wie erstelle oder verwalte ich API-Schlüssel?.

Davon zu unterscheiden sind die eingebauten Integrationen und Importfunktionen für bestimmte Dienste. Sie haben jeweils einen festgelegten Zweck und ersetzen keine beliebig nutzbare Schreibschnittstelle.

„Wie können Menschen von außen Anträge einreichen?“

Dafür gibt es vorbereitete öffentliche Formulare statt einer allgemeinen API.

Das Öffentliche Bewerbungsformular zu einem Tier aktivierst du unter Einstellungen → Vermittlungen. Für neue Vereinsmitglieder gibt es im entsprechenden Modul Mitglieder → Anmeldeformular mit einem Code zum Einbetten auf eurer Website.

Über solche Formulare gehen Bewerbungen beziehungsweise Anträge ein, die ihr nach dem vorgesehenen Ablauf prüft. Sie geben externen Personen nicht automatisch allgemeinen Schreibzugriff auf eure Vereinsdaten.

„Wir wissen nicht, wie man die Tierliste einbaut“

Sheltra liefert die Daten, baut eure Website aber nicht selbst um. Fragt die Person oder Agentur, die eure Website betreut. Bei einem Baukastensystem kann auch dessen Support klären, welche Einbindung möglich ist.

Die benötigten Adressen und Beispiele findest du wie beschrieben unter Wo finde ich die API-Dokumentation?. Gib dafür kein persönliches Sheltra-Passwort weiter.

„Kann Sheltra automatisch melden, dass sich etwas geändert hat?“

Für externe Anwendungen gibt es keine frei einrichtbaren Webhooks. Ein Webhook wäre eine automatische Nachricht an ein anderes Programm, sobald ein Ereignis eintritt.

Stattdessen muss eure Website die Daten regelmäßig abrufen. Das ist nicht exakt dasselbe wie eine sofortige Benachrichtigung: Zwischen einer Änderung und dem nächsten Abruf kann Zeit liegen. Weitere Informationen: Werden Webhooks unterstützt?.

„Bilder wirken zu groß oder unscharf“

Sheltra erstellt aus hochgeladenen Bildern kleinere Fassungen. Solange diese noch verarbeitet werden, kann das Original ausgeliefert werden.

Bleibt die Darstellung dauerhaft unpassend, prüft auch das Originalbild und die Einbindung auf eurer Website. Melde ein anhaltendes Verarbeitungsproblem an hallo@sheltra.cloud, statt dieselben Bilder ungeprüft immer wieder hochzuladen.

Technischer Hinweis für die Website-Betreuung

Die Leseschnittstelle lässt sich nach Ort, Art und Größe filtern und seitenweise abrufen. Bilder werden über Sheltra ausgeliefert, nicht über einen direkten Zugang zum Dateispeicher.

Für die öffentlichen Adressen gilt eine Grenze von 120 Abrufen pro Minute je Absender. Bei stark besuchten Websites ist eine geeignete Zwischenspeicherung sinnvoll, statt für jeden Besuch sofort neu abzurufen. Die Details stehen in der API-Dokumentation innerhalb der Anwendung.

Bei einer Fehlermeldung hilft Warum erhalte ich eine Fehlermeldung?.

Leo vom Sheltra-Team

Persönliche Hilfe

Du kommst an einer Stelle nicht weiter?

Unser Sheltra-Team schaut mit dir gemeinsam auf die Frage und hilft beim nächsten sinnvollen Schritt.