API-Schlüssel erhalten#

Schritt-für-Schritt-Anleitungen zum Erhalten des Schlüssels jedes Anbieters. Keiner ist erforderlich, um Seurch zu starten, aber mindestens eine Web-Suchmaschine (Brave ist am einfachsten) wird für nützliche Ergebnisse benötigt. Jeder Anbieter, den Sie überspringen, blendet seinen Tab oder seine Karte einfach aus; unter Suchanbieter finden Sie, was jeder aktiviert.

Sobald Sie einen Schlüssel haben, setzen Sie die entsprechende Umgebungsvariable (siehe Konfiguration) und starten Sie die App neu.

Die meisten haben ein kostenloses Kontingent, das für eine persönliche oder kleine Team-Instanz großzügig genug ist; Seurch cached aggressiv und ruft die kostenpflichtigen Karten-APIs nur auf, wenn eine Anfrage tatsächlich übereinstimmt. Die geteilten Schlüssel (public für Marginalia, anonymes Stack Exchange) benötigen überhaupt keine Anmeldung. TheTVDB ist die Ausnahme: Es hat kein kostenloses Kontingent und erfordert entweder eine kommerzielle Lizenz oder einen nutzerfinanzierten Schlüssel plus Abonnenten-PIN.

Brave Search — BRAVE_API_KEY#

Betreibt die Web-, Bilder-, Nachrichten- und Videos-Tabs von einem Schlüssel. Dies ist der Anbieter, den Sie zuerst einrichten sollten.

  1. Gehen Sie zur Brave Search API-Website und registrieren Sie sich beim API-Dashboard.
  2. Fügen Sie den Data for Search-Plan hinzu und wählen Sie das kostenlose Kontingent (fragt nach einer Karte zur Verifizierung, das kostenlose Kontingent wird aber nicht berechnet).
  3. Öffnen Sie API-Schlüssel im Dashboard und generieren Sie einen Schlüssel.
  4. Kopieren Sie ihn in BRAVE_API_KEY.

Brave Suggest (Autocomplete) — BRAVE_SUGGEST_API_KEY#

Aktiviert Autocomplete-Vorschläge in der Suchleiste. Dies ist ein separates Abonnement vom obigen Suchschlüssel mit eigenem Schlüssel.

  1. Im gleichen Brave API-Dashboard abonnieren Sie den Autosuggest-Plan (kostenloses Kontingent verfügbar).
  2. Generieren Sie einen Schlüssel für dieses Abonnement.
  3. Kopieren Sie ihn in BRAVE_SUGGEST_API_KEY.

Nicht gesetzt bedeutet ohne Autocomplete betreiben; alles andere funktioniert noch.

Mojeek — MOJEEK_API_KEY#

Fügt den unabhängigen Mojeek-Web-Index zum Web-Tab hinzu.

  1. Besuchen Sie die Mojeek Search API-Seite und beantragen Sie API-Zugang (ein kostenloses Kontingent ist verfügbar).
  2. Nach der Genehmigung kopieren Sie den ausgestellten Schlüssel.
  3. Setzen Sie ihn als MOJEEK_API_KEY.

Marginalia — MARGINALIA_API_KEY#

Fügt den nicht-kommerziellen Marginalia-Small-Web-Index hinzu. Keine Anmeldung erforderlich.

  • Der Literalwert public ist ein kostenloser geteilter Schlüssel und der Standard in .env.example, begrenzt auf etwa 1 Anfrage alle 5 Sekunden.
  • Für ein höheres, nicht geteiltes Kontingent fordern Sie einen persönlichen Schlüssel auf der Marginalia API-Seite an.
MARGINALIA_API_KEY=public   # funktioniert sofort

Staan — STAAN_API_KEY#

Fügt dem Web-Tab Staan hinzu, den europäischen Web-Index von European Search Perspective (dem Gemeinschaftsunternehmen von Qwant und Ecosia). Nur Web-Ergebnisse.

  1. Registrieren Sie sich auf staan.ai.
  2. Erstellen Sie in Ihrem Dashboard einen API-Schlüssel.
  3. Setzen Sie ihn als STAAN_API_KEY.

Das Kontingent beträgt 1.000 kostenlose Anfragen pro Monat, danach ab 1 EUR pro 1.000.

Die API von Staan begrenzt die Paginierung auf einen Offset von 30. Staan trägt daher zu den ersten vier Seiten einer Suche bei und entfällt danach. Ebenso werden Anfragen mit mehr als 400 Zeichen abgelehnt. In beiden Fällen antworten die übrigen Suchmaschinen weiterhin, die Seite bleibt also nie leer.

Pixabay (Bilder) — PIXABAY_API_KEY#

Mischt lizenzfreie Pixabay-Bilder in den Bilder-Tab.

  1. Erstellen Sie ein kostenloses Konto bei Pixabay.
  2. Öffnen Sie angemeldet die Pixabay API-Dokumentation; Ihr persönlicher API-Schlüssel wird oben auf dieser Seite angezeigt.
  3. Kopieren Sie ihn in PIXABAY_API_KEY.

World News API (Nachrichten) — WORLDNEWS_API_KEY#

Mischt Artikel der World News API in den Nachrichten-Tab.

  1. Registrieren Sie sich bei worldnewsapi.com (der kostenlose Plan gewährt ein tägliches Punktekontingent).
  2. Öffnen Sie Ihr Konto-Dashboard und kopieren Sie den API-Schlüssel.
  3. Setzen Sie ihn als WORLDNEWS_API_KEY.

TheTVDB (Film / TV-Karte) — THETVDB_API_KEY#

Aktiviert die Film / TV-Wissenskarte.

  1. Erstellen Sie ein Konto bei TheTVDB und öffnen Sie Ihr API-Schlüssel-Dashboard.
  2. TheTVDB lizenziert seine API auf zwei Arten; wählen Sie die, unter der Ihre Instanz tatsächlich lizenziert ist:
    • eine ausgehandelte / kommerzielle Lizenz, die nur den Schlüssel benötigt, oder
    • einen nutzerfinanzierten Schlüssel, der zusätzlich die TheTVDB-Abonnenten-PIN des Endnutzers benötigt.
  3. Kopieren Sie den Schlüssel in THETVDB_API_KEY und bei einem nutzerfinanzierten Schlüssel die Abonnenten-PIN in THETVDB_PIN (bei einer lizenzierten Variante leer lassen).

Die Namensnennung wird auf der Karte angezeigt, wie es die Bedingungen von TheTVDB verlangen.

TripAdvisor (Orte-Karte) — TRIPADVISOR_API_KEY#

Aktiviert die Restaurant / Hotel / Attraktionskarte.

  1. Registrieren Sie sich für die TripAdvisor Terra Partner API.
  2. Erstellen Sie im Entwicklerportal einen API-Schlüssel für den Tarif Ihres Kontos.
  3. Kopieren Sie ihn in TRIPADVISOR_API_KEY. Seurch sendet ihn als X-API-Key-Header.

Die alte Content API ist eingestellt. Für api.content.tripadvisor.com ausgestellte Schlüssel liefern jetzt 403. Wenn Ihre Orte-Karte nicht mehr erscheint, ist das der Grund: Holen Sie sich einen Terra-Schlüssel und ersetzen Sie den Wert.

Die Karte wird aus Terras Katalog-Endpunkten aufgebaut, die ohne Partner-Zulassungsliste und ohne Geofencing antworten. Diese Projektion ist reduziert: Die Karte zeigt daher den Namen des Betriebs, sein Gebiet, die Adresse, die Bewertung, die Anzahl der Rezensionen, eine Beschreibung und einen Link — und kein Foto, keine Küche, keine Preisklasse und kein Ranking, die nur für Standorte ausgeliefert werden, für die ein Partner einzeln lizenziert ist.

TripAdvisors Bedingungen verlangen die Anzeige von TripAdvisor-Attributionen, wo ihre Daten erscheinen, was Seurchs Karte bereits tut, und dass Seiten mit ihren Inhalten aus Suchmaschinen-Indizes herausgehalten werden, was Seurch tut, indem es jede Ergebnisseite mit dieser Karte als noindex markiert. Sie können den Schlüssel in deren Portal auch auf die IP Ihres Servers beschränken.

Stack Exchange (Q&A-Karte) — STACKEXCHANGE_API_KEY#

Aktiviert die Stack Exchange-Fragen-und-Antworten-Karte. Ein Schlüssel ist optional.

  • Ohne Schlüssel verwendet Seurch das gemeinsame anonyme Kontingent (10.000 Anfragen/Tag geteilt zwischen allen anonymen Aufrufern), was für geringen Datenverkehr ausreicht.

  • Mit einem Schlüssel erhalten Sie ein dediziertes, viel höheres Kontingent:

    1. Registrieren Sie eine App bei Stack Apps → Register OAuth (verwenden Sie die URL Ihrer Instanz; Sie benötigen den OAuth-Fluss nicht).
    2. Kopieren Sie den generierten Schlüssel.
    3. Setzen Sie ihn als STACKEXCHANGE_API_KEY.

Anbieter, die keinen Schlüssel benötigen#

Diese funktionieren sofort, ohne Konto oder Schlüssel:

AnbieterVerwendet für
OpenStreetMap / NominatimDer Karten-Tab und Karten-Schnellantworten
Wikipedia / WikidataDie Wikipedia-Wissenskarte und Themenerkennung
Sepia / PeerTubeDer ergänzende Anbieter des Videos-Tabs
Open-MeteoDie Wetter-Sofortantwort
FrankfurterDie Währungs-Sofortantwort

Der Übersetzen-Tab ist die einzige schlüssellose Funktion, die dennoch Infrastruktur benötigt: eine LibreTranslate-Instanz, auf die Sie Seurch zeigen; siehe Übersetzung.

Nach dem Hinzufügen von Schlüsseln#

  1. Legen Sie jeden Wert in Ihrer Umgebung (oder .env) fest; siehe Konfiguration.
  2. Starten Sie die App neu, damit sie die neuen Variablen aufnimmt.
  3. Überprüfen Sie die /status-Seite (oder den status/ API-Endpunkt), um zu bestätigen, dass jeder Anbieter als gesund gemeldet wird.