Integrationsleitfaden
Authentifizieren, suchen und die Ergebnisse lesen.
1. Authentifizierung
Rufen Sie von Ihrem Server mit API-Schlüssel und Content-Type: application/json-Headern auf. Halten Sie Ihren Schlüssel geheim.
Öffnen Sie die API-SchlüsselE 2. Parameter anfordern
Anfragen unterstützen nur Abfrage, Anzahl und search_lang. Die Abfrage akzeptiert eine Frage oder Schlüsselwörter in natürlicher Sprache.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| query | string | Ja | Eine Suchfrage oder Schlüsselwörter. Darf nicht leer sein. |
| count | integer | NEIN | Gewünschte Ergebnisanzahl. Lassen Sie 0 weg oder übergeben Sie es, um den Dienststandard zu verwenden. |
| search_lang | string | NEIN | Suchsprache, zum Beispiel zh-hans. Der Dienst normalisiert zh auf zh-hans. Klicken Sie auf diese Zeile, um die unterstützte Liste anzuzeigen. |
3. Rufen Sie die Suche API auf
https://api.starsg.ai/api/product/websearch/searchErsetzen Sie YOUR_API_KEY und stellen Sie die Abfrage auf Ihren Suchtext ein. count und search_lang sind optional.
curl -X POST 'https://api.starsg.ai/api/product/websearch/search' \
-H 'api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"query": "北京今天的天气",
"count": 5,
"search_lang": "zh-hans"
}'Senden Sie ein JSON-Objekt direkt, ohne Body Wrapper oder ein zusätzliches /v1.
4. Lesen Sie das Ergebnis
Überprüfen Sie zunächst den Erfolg. Bei Erfolg lesen Sie data.references und data.data; Überprüfen Sie bei einem Fehler errorCode und errorMsg. Der folgende Webinhalt dient der Veranschaulichung.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "Beispielhafte Smart-Home-Neuigkeiten",
"url": "https://example.com/article",
"summary": "Die Zusammenfassung der Suchergebnisse finden Sie hier.",
"published": "",
"extra": {}
}
],
"data": [
"Die Zusammenfassung der Suchergebnisse finden Sie hier."
]
},
"errorCode": null,
"errorMsg": null
}data.references | Webreferenzen mit Titeln, Links und Zusammenfassungen. |
data.data | Ergebnistextliste, verschachtelt im äußeren Datenobjekt. |
references[].website / logo | Name oder Domain der Website und Logo URL. |
references[].title / url / summary | Ergebnistitel, Originalseite URL und Zusammenfassung. |
references[].published / extra | Veröffentlichungsdatum und zusätzliche Informationen. Kann leer sein. |
success=true mit leeren Referenzen und Datenarrays bedeutet, dass keine gültigen Ergebnisse gefunden wurden. Probieren Sie andere Schlüsselwörter oder eine andere Suchsprache aus; Behandeln Sie es nicht als API-Fehler.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}Häufige Fehler und nächste Schritte
PARAM_INVALID | Überprüfen Sie JSON und fragen Sie ab. Korrigieren Sie die Parameter, bevor Sie es erneut versuchen. |
SEARCH_FAILED | Die Suche ist fehlgeschlagen. Versuchen Sie es später erneut, wobei die Anzahl der Versuche begrenzt ist. Speichern Sie bei anhaltenden Fehlern die Anrufzeit und die Anforderungskennung für den Support. |