Whale DocsData consumer guides
下载 Markdown

快速开始

完成本页后，你将使用平台分配给接入应用的订阅和应用密钥执行一次关键词检索。

接入前提

  1. 平台已为你的组织开通 Portal 账号。
  2. 组织下已有接入应用。
  3. 平台已给该应用分配有效订阅。
  4. 应用已有一枚有效 API Key。

当前验证环境 Base URL：

http://20.169.21.11

该地址只用于联调验证。正式生产接入必须使用平台交付的 HTTPS 域名。

第一次查询

export WHALE_BASE_URL='http://20.169.21.11'
export WHALE_API_KEY='whale_consumer_xxx'
 
curl --request POST "$WHALE_BASE_URL/v1/contents/search" \
  --header "Authorization: Bearer $WHALE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "mode": "keyword",
    "query": "人工智能",
    "source_platforms": ["weibo"],
    "top_k": 10
  }'

客户端不能通过请求参数扩大订阅范围。若应用未订阅微博，服务会拒绝请求或只返回其他已授权范围内的结果。

读取详情

从检索结果取得 document_id：

curl "$WHALE_BASE_URL/v1/documents/DOCUMENT_ID" \
  --header "Authorization: Bearer $WHALE_API_KEY"

完整正文：

curl "$WHALE_BASE_URL/v1/documents/DOCUMENT_ID/content" \
  --header "Authorization: Bearer $WHALE_API_KEY"

下一步