Panduan integrasi
Otentikasi, cari, dan baca hasilnya.
1. Otentikasi
Panggilan dari server Anda dengan api-key dan header Content-Type: application/json. Jaga kerahasiaan kunci Anda.
Buka Kunci API2. Parameter permintaan
Permintaan hanya mendukung kueri, penghitungan, dan search_lang. kueri menerima pertanyaan atau kata kunci bahasa alami.
| Bidang | Tipe | Diperlukan | Keterangan |
|---|---|---|---|
| query | string | Ya | Pertanyaan pencarian atau kata kunci. Tidak boleh kosong. |
| count | integer | TIDAK | Jumlah hasil yang diinginkan. Hilangkan atau teruskan 0 untuk menggunakan layanan default. |
| search_lang | string | TIDAK | Bahasa pencarian, misalnya zh-hans. Layanan ini menormalkan zh ke zh-hans. Klik baris ini untuk daftar yang didukung. |
3. Panggil pencarian API
https://api.starsg.ai/api/product/websearch/searchGanti YOUR_API_KEY dan setel kueri ke teks pencarian Anda. count dan search_lang adalah opsional.
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"
}'Kirim objek JSON secara langsung, tanpa pembungkus badan atau /v1. tambahan
4. Baca hasilnya
Periksa kesuksesan terlebih dahulu. Jika berhasil, baca data.references dan data.data; jika gagal, periksa errorCode dan errorMsg. Konten web di bawah ini adalah ilustrasi.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "Contoh berita rumah pintar",
"url": "https://example.com/article",
"summary": "Ringkasan hasil pencarian ada di sini.",
"published": "",
"extra": {}
}
],
"data": [
"Ringkasan hasil pencarian ada di sini."
]
},
"errorCode": null,
"errorMsg": null
}data.references | Referensi web dengan judul, tautan, dan ringkasan. |
data.data | Daftar teks hasil, bersarang di dalam objek data luar. |
references[].website / logo | Nama situs web atau domain dan logo URL. |
references[].title / url / summary | Judul hasil, halaman asli URL dan ringkasan. |
references[].published / extra | Tanggal publikasi dan informasi tambahan. Mungkin kosong. |
success=true dengan referensi kosong dan array data berarti tidak ditemukan hasil yang valid. Coba kata kunci lain atau bahasa pencarian lain; jangan memperlakukannya sebagai kegagalan API.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}Kesalahan umum dan langkah selanjutnya
PARAM_INVALID | Periksa JSON dan tanyakan. Perbaiki parameter sebelum mencoba lagi. |
SEARCH_FAILED | Pencarian gagal. Coba lagi nanti dengan batasan percobaan. Untuk kegagalan yang terus-menerus, hemat waktu panggilan dan minta pengidentifikasi untuk dukungan. |