Entegrasyon kılavuzu
Kimlik doğrulaması yapın, arayın ve sonuçları okuyun.
1. Kimlik doğrulama
API-key ve Content-Type: application/json başlıkları ile sunucunuzdan çağrı yapın. Anahtarınızı gizli tutun.
API Anahtarlarını Aç2. Parametreleri talep et
İstekler yalnızca sorgulamayı, sayımı ve search_lang'yi destekler. sorgu doğal dildeki bir soruyu veya anahtar kelimeleri kabul eder.
| Alan | Tür | Gerekli | Tanım |
|---|---|---|---|
| query | string | Evet | Bir arama sorusu veya anahtar kelimeler. Boş olmamalıdır. |
| count | integer | HAYIR | İstenilen sonuç sayısı. Hizmet varsayılanını kullanmak için 0'yi atlayın veya iletin. |
| search_lang | string | HAYIR | Arama dili, örneğin zh-hans. Hizmet zh'yi zh-hans'a normalleştirir. Desteklenen liste için bu satırı tıklayın. |
3. Aramayı çağırın API
https://api.starsg.ai/api/product/websearch/searchYOUR_API_KEY'inizi değiştirin ve sorguyu arama metninize ayarlayın. count ve search_lang isteğe bağlıdır.
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"
}'Bir JSON nesnesini gövde sarmalayıcı veya ekstra /v1. olmadan doğrudan gönderin
4. Sonucu okuyun
Önce başarıyı kontrol edin. Başarılı olduğunuzda data.references ve data.data'yı okuyun; arıza durumunda errorCode ve errorMsg'yi inceleyin. Aşağıdaki web içeriği örnek niteliğindedir.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "Örnek akıllı ev haberleri",
"url": "https://example.com/article",
"summary": "Arama sonucu özeti buraya gelir.",
"published": "",
"extra": {}
}
],
"data": [
"Arama sonucu özeti buraya gelir."
]
},
"errorCode": null,
"errorMsg": null
}data.references | Başlıklar, bağlantılar ve özetler içeren web referansları. |
data.data | Dış veri nesnesinin içine yerleştirilmiş sonuç metin listesi. |
references[].website / logo | Web sitesi adı veya etki alanı ve logosu URL. |
references[].title / url / summary | Sonuç başlığı, orijinal sayfa URL ve özet. |
references[].published / extra | Yayın tarihi ve ek bilgiler. Boş olabilir. |
Boş referanslara ve veri dizilerine sahip success=true, geçerli bir sonuç bulunmadığı anlamına gelir. Farklı anahtar kelimeleri veya farklı bir arama dilini deneyin; bunu bir API arızası olarak değerlendirmeyin.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}Yaygın hatalar ve sonraki adımlar
PARAM_INVALID | JSON'yi kontrol edin ve sorgulayın. Tekrar denemeden önce parametreleri düzeltin. |
SEARCH_FAILED | Arama başarısız oldu. Daha sonra deneme sayısı sınırıyla yeniden deneyin. Kalıcı arızalar için çağrı süresini kaydedin ve destek için tanımlayıcı isteyin. |