API-Dokumentation
Hier findet ihr unsere API-Dokumentation. Für den Zugriff auf unsere API benötigt ihr einen gültigen API-Schlüssel.
API-Schlüssel anfragen
Inhalt
Gefahrenwarnungen
Ihr könnt Gefahrenwarnungen über zwei Schnittstellen abfragen.

1. Gefahrenwarnungen im Umkreis einer bestimmten Koordinate für einen definierten Zeitraum.
2. Alle Gefahrenwarnungen für einen definierten Zeitraum.
Request Gefahrenwarnungen im Umkreis einer bestimmten Koordinate für einen definierten Zeitraum
POST dogguard-api.de/open/dogguards/location/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergen.
token: Der API-Schlüssel
location: Die GPS-Koordinate für die ihr Warnungen abrufen wollt.
radius: Der Umkreis der Koordinate in Metern, für die ihr Warnungen abrufen wollt.
range: Ein definierter Zeitraum, für den ihr Warnungen abrufen wollt. Das Datum müsst ihr im ISO-8601 Format übergeben.
Request:
{
"token": API-Key,
"location": {
"lon":-122.0312186,
"lat":37.33233141
},
"radius": 20000,
"range": {
"from": "2020-04-17 23:10:09.294Z",
"backTo": "2020-04-14 00:10:09.294Z"
}
}
Response Gefahrenwarnungen für einen definierten Zeitraum
Die API antwortet euch mit einer Liste von Dog Guards. Also den Gefahrenwarnungen. Die Attribute bedeuten folgendes.
_id: Die ID vom Dog Guard, der Gefahrenwarnung.
protection: Eine Angabe, um welche Gefahr es sich handelt.
poisonBait: Giftköder
studdedFood: Gespickte Nahrung
glassFragments: Glasscherben
oakProcessionary: Eichenprozessionsspinner
location: Die Position der Warnung. Sofern vorhanden mit: GPS-Koordinaten, Land, Stadt, Postleiztahl, Straße, Hausnummer.
created: Das Erstellungsdatum der Warnung.
hasImage: Sofern die API das Attribut ausspielt, könnt ihr für die Gefahrenwarnung ein Bild abrufen.
Response:
[
{
"_id": "5eabd86210427417c7a26555",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T08:05:54.004Z"
},
{
"_id": "5eac015010427417c7a26557",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T11:00:32.503Z",
"hasImage": true,
"countOfComments": 4
}
]
Request Gefahrenwarnungen für einen definierten Zeitraum
POST dogguard-api.de/open/dogguards/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergen.
token: Der API-Schlüssel
range: Ein definierter Zeitraum, für den ihr Warnungen abrufen wollt. Das Datum müsst ihr im ISO-8601 Format übergeben.
Request:
{
"token": API-Key,
"range": {
"from": "2020-04-17 23:10:09.294Z",
"backTo": "2020-04-14 00:10:09.294Z"
}
}
Response Gefahrenwarnungen für einen definierten Zeitraum
Die API antwortet euch mit einer Liste von Dog Guards. Also den Gefahrenwarnungen. Die Attribute bedeuten folgendes.
_id: Die ID vom Dog Guard, der Gefahrenwarnung.
protection: Eine Angabe, um welche Gefahr es sich handelt.
poisonBait: Giftköder
studdedFood: Gespickte Nahrung
glassFragments: Glasscherben
oakProcessionary: Eichenprozessionsspinner
location: Die Position der Warnung. Sofern vorhanden mit: GPS-Koordinaten, Land, Stadt, Postleiztahl, Straße, Hausnummer.
created: Das Erstellungsdatum der Warnung.
hasImage: Sofern die API das Attribut ausspielt, könnt ihr für die Gefahrenwarnung ein Bild abrufen.
Response:
[
{
"_id": "5eabd86210427417c7a26555",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T08:05:54.004Z"
},
{
"_id": "5eac015010427417c7a26557",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T11:00:32.503Z",
"hasImage": true,
"countOfComments": 4
}
]
Nutzerrating
Das Nutzerrating gibt euch einen Eindruck über die Validität der Warnung. Es zeigt, wieviele Nutzer eine Warnung bestätigt oder widersprochen haben.
Request für das Nutzerrating einer Gefahrenwarnung
POST dogguard-api.de/open/dogguards/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergeben.
token: Der API-Schlüssel
dogGuard: Der Dog Guard, also die Gefahrenwarnung für die ihr das Nutzerrating haben wollt.
Request:
{
"token": API-Key,
"dogGuard": {
"_id": "5eabd86210427417c7a26555"
}
}
Response für das Nutzerrating einer Gefahrenwarnung
Die API antwortet mit einer Liste von Votes. Enthält der Vote den Wert 1, hat ein Nutzer die Warnung bestätigt. Enthält ein Vote den Wert -1 hält ein Nutzer die Warnung für falsch. Die Attribute bedeuten folgendes. _id: Die ID vom Vote.
idDogGuard: Die ID vom Dog Guard, also der Gefahrenwarnung für die ein Nutzer einen Vote abgegeben hat.
value: Enthält der Vote den Wert 1, hat ein Nutzer die Warnung bestätigt. Enthält ein Vote den Wert -1 hält ein Nutzer die Warnung für falsch.
created: Das Erstellungsdatum vom Vote.
Response:
[
{
"_id": "5eabffd010427417c7a26556",
"idDogGuard": "5eabd86210427417c7a26555",
"value": 1,
"created": "2020-05-01T10:54:08.112Z"
},
{
"_id": "5eabffd010427417c7a26556",
"idDogGuard": "5eabd86210427417c7a26555",
"value": -1,
"created": "2020-05-01T11:54:08.112Z"
}
]
Bilder zur Warnung
Nutzer können zu jeder Warnung ein Bild veröffentlichen. Das Bild steigert noch einmal die Genauigkeit der Warnung, da es Umgebung oder die Gefahr selbst zeigt.
Request für ein Bild zur Gefahrenwarnung
POST dogguard-api.de/open/image/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergeben.
token: Der API-Schlüssel
dogGuard: Der Dog Guard, also die Gefahrenwarnung, für die ihr das Bild haben wollt.
Request:
{
"token": API-Key,
"dogGuard": {
"_id": "5eabd86210427417c7a26555"
}
}
Response für ein Bild zur Gefahrenwarnung
Die API antwortet mit einer Entity, welche das Bild als Base64-encodiertes JPG enthält. Die Attribute bedeuten folgendes.
_id: Die ID vom Bild.
data: Das Base64-encodierte JPG.
created: Das Erstellungsdatum vom Bild.
idDogGuard: Die ID vom Dog Guard, also der Gefahrenwarnung zu der das Bild gehört.
Response:
{
"_id": "5eac015110427417c7a26558",
"data": "/9j/4AAQSQ...XMf//Z",
"created": "2020-05-01T11:00:33.068Z",
"idDogGuard": "5eac015010427417c7a26557"
}
Nutzerkommentare zur Warnung
Nutzerkommentare steigern noch einmal den Informationsgehalt der Warnung. Sie klären Nachfragen aus der Community oder enthalten wichtige zusätzliche Informationen zur Warnung.
Request für Nutzerkommentare zur Gefahrenwarnung
POST dogguard-api.de/open/comments/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergeben.
token: Der API-Schlüssel
dogGuard: Der Dog Guard, also die Gefahrenwarnung für die ihr die Kommentare haben wollt.
Request:
{
"token": API-Key,
"dogGuard": {
"_id": "5eabd86210427417c7a26555"
}
}
Response für Nutzerkommentare zur Gefahrenwarnung
Die API antwortet mit einer Liste von Kommentaren. Die Attribute bedeuten folgendes.
_id: Die ID vom Kommentar.
text: Der Kommentartext.
author: Der Autor vom Kommentar. Autoren sind anonym und nur über eine Ziffer unterscheidbar. Der erste Nutzer, welcher einen Kommentar zur Warnung verfasst erhält die Ziffer 1, der folgende Nutzer erhält die Ziffer 2 usw. Beteiligt sich der erste Nutzer wieder am Gespräch, erhält er wieder seine Ziffer 1.
created: Das Erstellungsdatum vom Kommentar.
idDogGuard: Die ID vom Dog Guard, also der Gefahrenwarnung.
Response:
[
{
"_id": "5eac076710427417c7a26559",
"text": "Hallo",
"created": "2020-05-01T11:26:31.172Z",
"author": "1",
"idDogGuard": "5eac015010427417c7a26557"
},
{
"_id": "5eac077810427417c7a2655b",
"text": "Hi",
"created": "2020-05-01T11:26:48.342Z",
"author": "2",
"idDogGuard": "5eac015010427417c7a26557"
},
{
"_id": "5eac077f10427417c7a2655d",
"text": "Wie gehts?",
"created": "2020-05-01T11:26:55.372Z",
"author": "1",
"idDogGuard": "5eac015010427417c7a26557"
},
]
AGB
Datenschutz
Impressum
Future Fever | Philipp Faßheber | Otto-Schott-Straße 23 | 07745, Jena
futurefever.de | dogguardapp.de