NB-Public
/
green-spider-api
mirror of https://github.com/netzbegruenung/green-spider-api.git
14
0
Fork 0
Code Issues Projects Releases Wiki Activity
Web service API für Green Spider https://github.com/netzbegruenung/green-spider
18 Commits 27 Branches 0 Tags 665 KiB
Python 95.2%
Makefile 2.4%
Dockerfile 2.4%
Go to file
Marian Steinbach d344060d3f Add upgrading of pip 2019-04-15 21:46:20 +02:00
.dockerignore First working version 2018-10-31 23:23:05 +01:00
.gitignore First working version 2018-10-31 23:23:05 +01:00
Dockerfile Add upgrading of pip 2019-04-15 21:46:20 +02:00
LICENSE Set copyright owner in license 2018-10-30 21:42:00 +01:00
Makefile First working version 2018-10-31 23:23:05 +01:00
README.md Add docs for screenshots endpoint 2018-11-12 22:25:06 +01:00
jsonhandler.py First working version 2018-10-31 23:23:05 +01:00
main.py Adapt CompactResults to use ES 2019-04-12 09:15:35 +02:00
main_test.py Add big result export 2018-11-26 09:35:52 +01:00
requirements.txt Add elasticsearch dependency 2019-04-12 09:16:02 +02:00

README.md

Docker Repository on Quay

green-spider-api

Web service API für die Green Spider Webapp

API Dokumentation

Hinweis: Die API ist in einer frühen Entwicklungsphase. Änderungen (breaking changes) ohne vorherige Ankündigung sind zu erwarten.

GET /api/v1/spider-results/last-updated/

Gibt den Zeitpunkt der letzten Aktualisierung der Spider-Ergebnisse zurück.

{
  "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.

[
  {
    "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
  },
  ...
]

GET /api/v1/spider-results/site?url={site_url}

Gibt sämtliche Inhalte zu einer Site aus.

Ein Beispiel würde hier den Rahmen sprengen.

GET /api/v1/screenshots?url={site_url}

Gibt Daten zu allen vorhandenen Screenshots zu einer Site aus.

[
  {
    "url": "http://wordpress.gruene-hameln-pyrmont.de/category/hessisch-oldendorf-gesamt/",
    "screenshot_url": "http://green-spider-screenshots.sendung.de/1500x1500/4fc61b4918dc9eaaef645c694c84224e.png",
    "user_agent": "phantomjs-2.1.1",
    "size": [1500, 1500],
    "created": "2018-10-08T08:33:21.284933+00:00"
  },
  {
    "url": "http://wordpress.gruene-hameln-pyrmont.de/category/hessisch-oldendorf-gesamt/",
    "screenshot_url": "http://green-spider-screenshots.sendung.de/360x640/4fc61b4918dc9eaaef645c694c84224e.png",
    "user_agent": "phantomjs-2.1.1",
    "size": [360, 640],
    "created": "2018-10-08T08:33:19.353841+00:00"
  }
]

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.