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 API

2. Solicitar parámetros

Las solicitudes solo admiten consultas, recuentos y search_lang. La consulta acepta una pregunta o palabras clave en lenguaje natural.

campoTipoRequeridoDescripción
querystringSíUna pregunta de búsqueda o palabras clave. No debe estar vacío.
countintegerNoRecuento de resultados deseados. Omita o pase 0 para utilizar el servicio predeterminado.

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.

Respuesta exitosa
json
{
  "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.referencesReferencias web con títulos, enlaces y resúmenes.
data.dataLista de texto de resultados, anidada dentro del objeto de datos externo.
references[].website / logoNombre o dominio del sitio web y logotipo URL.
references[].title / url / summaryTítulo del resultado, página original URL y resumen.
references[].published / extraFecha 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.

Respuesta de error
json
{
  "success": false,
  "data": null,
  "errorCode": "PARAM_INVALID",
  "errorMsg": "query is required"
}

Errores comunes y próximos pasos

PARAM_INVALIDRevisa el JSON y consulta. Corrija los parámetros antes de volver a intentarlo.
BÚSQUEDA_FAILEDLa 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.