Руководство по интеграции
Аутентификация, поиск и чтение результатов.
1. Аутентификация
Вызов с вашего сервера с помощью API-ключа и заголовков Content-Type: application/json. Держите свой ключ в тайне.
Открыть ключи API2. Параметры запроса
Запросы поддерживают только запрос, подсчет и search_lang. запрос принимает вопрос или ключевые слова на естественном языке.
| Поле | Тип | Необходимый | Описание |
|---|---|---|---|
| query | string | Да | Поисковый вопрос или ключевые слова. Не должно быть пустым. |
| count | integer | Нет | Желаемый результат. Опустите или передайте 0, чтобы использовать службу по умолчанию. |
| search_lang | string | Нет | Язык поиска, например ж-ханс. Сервис нормализует ж в ж-ханс. Щелкните эту строку, чтобы просмотреть список поддерживаемых устройств. |
3. Вызовите поиск API
https://api.starsg.ai/api/product/websearch/searchЗамените YOUR_API_KEY и установите запрос на текст поиска. count и search_lang не являются обязательными.
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"
}'Отправьте объект JSON напрямую, без оболочки тела или дополнительного /v1..
4. Прочитайте результат
Сначала проверьте успех. В случае успеха прочитайте data.references и data.data; в случае сбоя проверьте errorCode и errorMsg. Веб-контент ниже носит иллюстративный характер.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "Пример новостей умного дома",
"url": "https://example.com/article",
"summary": "Здесь находится сводка результатов поиска.",
"published": "",
"extra": {}
}
],
"data": [
"Здесь находится сводка результатов поиска."
]
},
"errorCode": null,
"errorMsg": null
}data.references | Веб-ссылки с заголовками, ссылками и резюме. |
data.data | Текстовый список результатов, вложенный во внешний объект данных. |
references[].website / logo | Название веб-сайта или домен и логотип URL. |
references[].title / url / summary | Заголовок результата, исходная страница URL и резюме. |
references[].published / extra | Дата публикации и дополнительная информация. Может быть пустым. |
success=true с пустыми ссылками и массивами данных означает, что действительные результаты не найдены. Попробуйте другие ключевые слова или другой язык поиска; не рассматривайте это как сбой API.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}Распространенные ошибки и дальнейшие действия
PARAM_INVALID | Проверьте JSON и выполните запрос. Исправьте параметры перед повторной попыткой. |
SEARCH_FAILED | Поиск не удался. Повторите попытку позже с ограничением количества попыток. В случае постоянных сбоев сохраните время звонка и идентификатор запроса для поддержки. |