API-Dokumentation

Auf dieser Seite dokumentieren wir unsere API, die zum Verwalten der Solr-Indizes genutzt werden kann. Über das Menü in der linken Sidebar können die verschiedenen Abschnitte angesteuert werden.

Authentifizierung

Die Authentifizierung erfolgt über zwei Parameter: dem api_token und secret_token. Diese sind im persönlichen Bereich unter dem Menüpunkt API verfügbar. Um eine erfolgreiche Authentifizierung durchzuführen, müssen die beiden Parameter bei jedem API-Call gesetzt werden.
Falls Sie also beispielsweise als api_token den Wert 123 und als secret_token den Wert 456 haben, würde eine API-Anfrage wie folgt aussehen:

curl https://www.hosted-solr.com/api/solr_cores.json?api_token=123&secret_token=456

Falls die Authentifizierung fehl schlägt, wird der HTTP-Statuscode 403 zurückgeliefert.

Solr-Indizes anzeigen

Um alle verfügbaren Solr-Indizes anzeigen zu lassen genügt folgender Aufruf:

curl https://www.hosted-solr.com/api/solr_cores.json?api_token=123&secret_token=456

Eine erfolgreiche Antwort sieht wie folgt aus:

[{
  "id":            1,
  "name":          "test",
  "created_at":    "2013-08-08T12:04:34Z",
  "updated_at":    "2013-08-08T12:04:34Z",
  "user_id":       1,
  "solr_version":  "3.5",
  "internal_name": "18221ac1e6b-test",
  "password":      "cb50cf62d14",
  "is_activated":  true,
  "system":        "typo3"
}]

Als HTTP-Statuscode wird 200 verwendet.

Neuen Solr-Index anlegen

Beim Anlegen eines neuen Solr-Index müssen diverse Attribute gesetzt werden. Die verfügbaren Attribute sind in der folgenden Tabelle aufgelistet:

name Pflichtfeld Spezifiziert den Indexnamen
solr_version Pflichtfeld Spezifiziert die verwendete Solr-Version (3.5 oder 3.6).
system Pflichtfeld Spezifiziert das verwendete System (typo3 oder sunspot).
schema Optionales Feld Spezifiziert das verwendete Schema bei TYPO3 (english, german, ..).

curl -gX POST https://www.hosted-solr.com/api/solr_cores.json?solr_core[name]=foo&solr_core[solr_version]=3.6&solr_core[schema]=typo3&api_token=123&secret_token=456

Falls der Datensatz erfolgreich angelegt wurde, wird der HTTP-Statuscode 201 zurückgegeben. Andernfalls wird 422 ausgeliefert.

Solr-Index löschen

Ein Solr-Index kann durch Verwendung der HTTP-Methode DELETE gelöscht werden. Dazu muss die Id des Solr-Index bekannt sein. Soll beispielsweise der Solr-Index mit der Id 1 gelöscht werden, kann folgender Aufruf verwendet werden:

curl -X DELETE https://www.hosted-solr.com/api/solr_cores/1.json?api_token=123&secret_token=456

Wenn der Solr-Index erfolgreich gelöscht wurde, wird der HTTP-Statuscode 204 zurückgeliefert. Falls der Solr-Index nicht gefunden werden konnte, wird mit 404 geantwortet.

Feedback