green-spider-api/README.md

44 lines
995 B
Markdown
Raw Normal View History

2018-10-30 21:41:22 +01:00
# green-spider-api
2018-10-31 23:23:05 +01:00
2018-10-30 21:41:22 +01:00
Web service API für Green Spider
2018-10-31 23:23:05 +01:00
## API Dokumentation
### `GET /api/v1/spider-results/last-updated/`
Gibt den Zeitpunkt der letzten Aktualisierung der Spider-Ergebnisse zurück.
```json
{
"last_updated": "2018-10-25T15:23:30.589683"
}
```
### `GET /api/v1/spider-results/compact/`
Gibt die kompakte Liste aller Sites aus. Diese enthält nur die Details, die für eine Übersicht benötigt werden.
```json
[
{
"input_url": "https://www.gruenekoeln.de/bezirke/bezirk7.html",
"created": "2018-10-31T01:21:03.361931+00:00",
"meta": {
"level": "DE:ORTSVERBAND",
"state": "Nordrhein-Westfalen",
"type": "REGIONAL_CHAPTER",
"city": "Köln-Porz/Poll",
"district": "Köln"
},
"score": 11.5
},
...
]
```
## Konfiguration
Umgebungsvariablen:
- `GCLOUD_DATASTORE_CREDENTIALS_PATH`: Pfad der JSON-Datei mit Google Cloud Service-Account-Credentials. Benötigt lesenden Zugriff auf `spider-results` Datastore-Entitäten.