Guide d'intégration
Authentifiez-vous, recherchez et lisez les résultats.
1. Authentification
Appelez depuis votre serveur avec la clé API et les en-têtes Content-Type : application/json. Gardez votre clé privée.
Ouvrir les clés API2. Paramètres de la demande
Les requêtes prennent uniquement en charge les requêtes, les nombres et search_lang. La requête accepte une question ou des mots-clés en langage naturel.
| Champ | Type | Requis | Description |
|---|---|---|---|
| query | string | Oui | Une question de recherche ou des mots-clés. Ne doit pas être vide. |
| count | integer | Non | Nombre de résultats souhaités. Omettez ou transmettez 0 pour utiliser la valeur par défaut du service. |
| search_lang | string | Non | Langue de recherche, par exemple zh-hans. Le service normalise zh en zh-hans. Cliquez sur cette ligne pour afficher la liste prise en charge. |
3. Appelez la recherche API
https://api.starsg.ai/api/product/websearch/searchRemplacez YOUR_API_KEY et définissez la requête sur votre texte de recherche. count et search_lang sont facultatifs.
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"
}'Envoyez un objet JSON directement, sans enveloppe de corps ni /v1. supplémentaire
4. Lire le résultat
Vérifiez d'abord le succès. En cas de succès, lisez data.references et data.data ; en cas d'échec, inspectez errorCode et errorMsg. Le contenu Web ci-dessous est illustratif.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "Exemple d'actualités sur la maison intelligente",
"url": "https://example.com/article",
"summary": "Le résumé des résultats de la recherche se trouve ici.",
"published": "",
"extra": {}
}
],
"data": [
"Le résumé des résultats de la recherche se trouve ici."
]
},
"errorCode": null,
"errorMsg": null
}data.references | Références Web avec titres, liens et résumés. |
data.data | Liste de textes de résultat, imbriquée dans l'objet de données externe. |
references[].website / logo | Nom ou domaine du site Web et logo URL. |
references[].title / url / summary | Titre du résultat, page originale URL et résumé. |
references[].published / extra | Date de publication et informations supplémentaires. Peut-être vide. |
success=true avec des références et des tableaux de données vides signifie qu'aucun résultat valide n'a été trouvé. Essayez différents mots-clés ou une autre langue de recherche ; ne le traitez pas comme un échec API.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}Erreurs courantes et étapes suivantes
PARAM_INVALID | Vérifiez le JSON et interrogez. Corrigez les paramètres avant de réessayer. |
SEARCH_FAILED | La recherche a échoué. Réessayez plus tard en limitant le nombre de tentatives. En cas d'échecs persistants, enregistrez l'heure de l'appel et demandez l'identifiant pour l'assistance. |