JavaScript SDK 使用说明

本指南介绍如何在**纯 JavaScript（Node.js）**中使用 Dataify SDK。Dataify 的 TypeScript SDK 发布时已编译为 ESM 格式的 JavaScript（dist/index.js），因此同一包既能在 TypeScript 中使用，也能直接在 JavaScript 中使用——两者 API 完全一致，区别仅在于 JS 不带类型标注。

与 TypeScript SDK 的关系

JS 与 TS 用的是同一个 npm 包 dataify-sdk：TS 用其类型定义（.d.ts），JS 用其编译后的运行时代码。

该包声明为 "type": "module"（ESM-only），没有 CommonJS 构建产物。因此请确保用 ESM 方式引入：

方案 A：文件用 .mjs 扩展名（推荐，最简单）；

方案 B：在你的项目 package.json 中设置 "type": "module"；

方案 C（CommonJS 项目）：使用动态 import()。

⚠️ 在 CommonJS（.cjs / 无 "type":"module"）中直接 require("dataify-sdk") 会报 ERR_REQUIRE_ESM，请改用下方「CommonJS 项目」写法。

安装与配置

配置

须提供 Dataify API Key。可在 Dataify 控制台获取。

选项 1：环境变量（推荐）

选项 2：直接初始化

DataifyClient 构造参数：apiKey（必填）、scraperBaseUrl、webUnlockerBaseUrl、timeoutMs、fetchImpl。

基本用法（ESM，`.mjs`）

所有调用均返回 Promise，使用 await：

运行：node demo.mjs

发起搜索引擎（SERP）

SERP 方法挂在 client.tools 下，按引擎命名。以下按引擎分列（若把文档部署到 VitePress / Docusaurus，可将下列分节改写为 <Tabs> 交互标签）：

Google 搜索

Google 图片

Google 新闻 / 趋势 / 地图

Bing 搜索

全部 SERP 方法见 client.tools.specs。

平台专用采集（Scrapers）

采集工具挂在 client.tools 下，方法名小驼峰。以下按平台分列：

Amazon

Instagram / YouTube / Walmart

全部工具名见 client.tools.specs。

Web Unlocker

下载抓取结果

CommonJS 项目写法

若你的项目是 CommonJS（无法使用顶层 import），用动态 import()：

运行：node demo.cjs

运行时端点与鉴权

能力	端点
Scraper / SERP	`https://scraperapi.dataify.com`
Web Unlocker	`https://webunlocker.dataify.com`

所有请求均携带 Authorization: Bearer <apiKey>。

安全注意事项

不要在浏览器前端代码中直接使用本 SDK，否则 API Key 会暴露。

推荐架构：前端 → 你的后端 → dataify-sdk → Dataify APIs。

编辑器支持 / 自省

JS 无编译期类型，但可借助同一包的 .d.ts 在支持 TS 的编辑器中获得提示；运行时可用 client.tools.specs 自省全部工具元信息（含 params / required / id）。

全部方法名与参数见 client.tools.specs。

错误处理

所有方法返回 Promise，用 try/catch 捕获异常：

完整示例（`.mjs`）

资源

资源	说明	链接
📘 GitHub 仓库	查看源码、示例并做出贡献	GitHub
📦 npm 页面	软件包列表与发布历史记录	dataify-sdk

JavaScript SDK 使用说明

与 TypeScript SDK 的关系#

安装与配置#

配置#

基本用法（ESM，.mjs）#

发起搜索引擎（SERP）#

Google 搜索#

Google 图片#

Google 新闻 / 趋势 / 地图#

Bing 搜索#

平台专用采集（Scrapers）#

Amazon#

LinkedIn#

Instagram / YouTube / Walmart#

Web Unlocker#

下载抓取结果#

CommonJS 项目写法#

运行时端点与鉴权#

安全注意事项#

编辑器支持 / 自省#

错误处理#

完整示例（.mjs）#

资源#