guía de integración
Autenticar, buscar y leer los resultados.
1. Autenticación
Llame desde su servidor con api-key y encabezados Content-Type: application/json. Mantenga su clave privada.
Abrir claves API2. Solicitar parámetros
Las solicitudes solo admiten consultas, recuentos y search_lang. La consulta acepta una pregunta o palabras clave en lenguaje natural.
| campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| query | string | Sí | Una pregunta de búsqueda o palabras clave. No debe estar vacío. |
| count | integer | No | Recuento de resultados deseados. Omita o pase 0 para utilizar el servicio predeterminado. |
| search_lang | string | No | Idioma de búsqueda, por ejemplo zh-hans. El servicio normaliza zh a zh-hans. Haga clic en esta fila para ver la lista compatible. |
3. Llame a la búsqueda API
https://api.starsg.ai/api/product/websearch/searchReemplace YOUR_API_KEY y establezca la consulta en su texto de búsqueda. count y search_lang son opcionales.
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"
}'Envíe un objeto JSON directamente, sin envoltura corporal ni un /v1. adicional
4. leer el resultado
Primero verifique el éxito. Si tiene éxito, lea datos.referencias y datos.datos; en caso de falla, inspeccione el código de error y el mensaje de error. El contenido web a continuación es ilustrativo.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "Ejemplo de noticias sobre hogares inteligentes",
"url": "https://example.com/article",
"summary": "El resumen de los resultados de la búsqueda va aquí.",
"published": "",
"extra": {}
}
],
"data": [
"El resumen de los resultados de la búsqueda va aquí."
]
},
"errorCode": null,
"errorMsg": null
}data.references | Referencias web con títulos, enlaces y resúmenes. |
data.data | Lista de texto de resultados, anidada dentro del objeto de datos externo. |
references[].website / logo | Nombre o dominio del sitio web y logotipo URL. |
references[].title / url / summary | Título del resultado, página original URL y resumen. |
references[].published / extra | Fecha de publicación e información adicional. Puede estar vacío. |
success=true con referencias vacías y matrices de datos significa que no se encontraron resultados válidos. Pruebe diferentes palabras clave o un idioma de búsqueda diferente; no lo trate como una falla API.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}Errores comunes y próximos pasos
PARAM_INVALID | Revisa el JSON y consulta. Corrija los parámetros antes de volver a intentarlo. |
BÚSQUEDA_FAILED | La búsqueda fracasó. Vuelva a intentarlo más tarde con un límite de intentos. Para fallas persistentes, guarde el tiempo de la llamada y solicite un identificador para soporte. |