Verwaltung der Solr-Indizes
Authentifizierung Solr-Indizes anzeigen Neuen Solr-Index anlegen Solr-Index löschen
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://app.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://app.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 |
variant Pflichtfeld | Spezifiziert den Namen der Variante |
system Pflichtfeld | Spezifiziert das verwendete System. |
solr_version Pflichtfeld | Spezifiziert die verwendete Solr-Version. |
schema Pflichtfeld | Spezifiziert das verwendete Schema bei TYPO3 (english, german, ..). |
Verfügbare Konfigurationen:
TYPO3 CMS | |
8.5 (TYPO3 10.4LTS + EXT:Solr 11.0.x) | |
variant: | ext-11.0 |
system: | typo3 |
solr_version: | 8.5.1 |
schema: | arabic, armenian, basque, bulgarian, burmese, catalan, chinese, czech, danish, dutch, english, finnish, french, galician, german, greek, hindi, hungarian, indonesian, italian, japanese, khmer, korean, lao, norwegian, persian, polish, portuguese, romanian, russian, spanish, swedish, thai, turkish, ukrainian |
8.2 (TYPO3 9.5LTS + EXT:solr 10.0.x) | |
variant: | ext-10.0 |
system: | typo3 |
solr_version: | 8.2.0 |
schema: | arabic, armenian, basque, bulgarian, burmese, catalan, chinese, czech, danish, dutch, english, finnish, french, galician, german, greek, hindi, hungarian, indonesian, italian, japanese, khmer, korean, lao, norwegian, persian, polish, portuguese, romanian, russian, spanish, swedish, thai, turkish, ukrainian |
7.6 (TYPO3 8.7LTS + EXT:solr 9.0.x) | |
variant: | ext-9.0 |
system: | typo3 |
solr_version: | 7.6.0 |
schema: | arabic, armenian, basque, bulgarian, burmese, catalan, chinese, czech, danish, dutch, english, finnish, french, galician, german, greek, hindi, hungarian, indonesian, italian, japanese, khmer, korean, lao, norwegian, persian, polish, portuguese, romanian, russian, spanish, swedish, thai, turkish, ukrainian |
Drupal |
Magento Integernet |
Magento SolrBridge |
Magento |
Sunspot |
Wordpress |
curl -gX POST 'https://app.hosted-solr.com/api/solr_cores.json?solr_core[name]=foo&solr_core[variant]=ext-6.0&solr_core[solr_version]=6.3.0&solr_core[system]=typo3&solr_core[schema]=german&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://app.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.