# 获取蒲公英博主笔记案例 v2（覆盖跨域）/Get PGY blogger note cases v2 (cross-platform) ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/xiaohongshu/pgy/get_blogger_notes_v2: post: summary: 获取蒲公英博主笔记案例 v2（覆盖跨域）/Get PGY blogger note cases v2 (cross-platform) deprecated: false description: >- # [中文] ### 用途: - 分页获取博主的笔记案例（v2）。与 `/get_blogger_notes` 是**两套独立接口**： 覆盖范围更广（含跨平台/跨域笔记），返回结构也不同 - **当 `/get_blogger_notes` 返回空列表时改用本接口** - 两接口的 note_type 取值与返回字段都不一样，不能混用，按各自参数调用 ### 请求体参数: - user_id: **必填**，博主用户ID - page_number: 页码，从 1 开始 - page_size: 每页数量，**1-8**（蒲公英网页固定 8，不能更大） - note_type: 笔记类型，0=全部类型(默认) 1=图文 2=视频 - order_type: 排序，1=最新发布(默认) 2=阅读最多 3=互动最多 ### 返回: - noteList[]: 笔记数组，每条含 noteInfo（noteId / title / imageUrl / notePublishTime / noteType / impNum 曝光 / readNum 阅读 / engageNum 互动 / favNum 收藏）+ userInfo（博主信息） - total: 符合筛选的笔记总数 ### 翻页: - 只改 page_number，其余参数原样保持不变；翻到某页返回空数组即没有更多 ### 响应结构（取数要剥两层）: - `resp["data"]` 是蒲公英原样信封（含 `code`/`msg`/`success`），业务数据还在它里面一层 - 正确取法：`data = resp["data"]["data"]`；下面「返回」列的字段都在这一层下 ### 计费: - HTTP 200 → **计费**。包含「查无结果」（`data` 为 null，如 ID 不存在或筛选无命中）—— 请求已送达蒲公英，同样扣费，不要因为拿不到数据就重试 - HTTP 400 → 不计费（参数格式非法，或上游资源不足/异常） # [English] ### Purpose: - Paginated note cases of a blogger (v2). A **separate endpoint** from `/get_blogger_notes`: wider coverage (incl. cross-platform notes) and a different response shape - **Use this when `/get_blogger_notes` returns an empty list** - The two endpoints differ in note_type values and return fields; do not mix them ### Request Body Parameters: - user_id: **required**, blogger user ID - page_number: page number from 1 - page_size: **1-8** (fixed at 8 on the PGY web page, cannot be larger) - note_type: 0=all (default), 1=image-text, 2=video - order_type: 1=newest (default), 2=most read, 3=most engaged ### Return: - noteList[]: each item has noteInfo (noteId / title / imageUrl / notePublishTime / noteType / impNum / readNum / engageNum / favNum) + userInfo - total: total notes matching the filters ### Paging: - Change page_number only, keep other params identical; an empty array means no more data ### Response shape (two layers): - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing: - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) # [示例/Example] ```json // ① 第一页 {"user_id": "592b6f7c5e87e74d3669f3ba", "page_number": 1, "page_size": 8} // ② 只看视频笔记 {"user_id": "592b6f7c5e87e74d3669f3ba", "page_number": 1, "page_size": 8, "note_type": 2} // ③ 换排序 {"user_id": "592b6f7c5e87e74d3669f3ba", "page_number": 1, "page_size": 8, "order_type": 2} ``` **什么时候用这个**：`/get_blogger_notes` 对跨域博主返空时。 返回结构与那个接口不同（本接口在 `noteList[].noteInfo` 下），解析代码不要混用。 Use this when `/get_blogger_notes` returns empty for a cross-domain blogger. operationId: get_blogger_notes_v2_api_v1_xiaohongshu_pgy_get_blogger_notes_v2_post tags: - Xiaohongshu-PGY-API - Xiaohongshu-PGY-API parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/NotesV2Req' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' headers: {} x-apifox-name: '' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' headers: {} x-apifox-name: '' security: - HTTPBearer: [] x-apifox: schemeGroups: - id: sD9hP6nDDhG18GKSbLAb3 schemeIds: - HTTPBearer required: true use: id: sD9hP6nDDhG18GKSbLAb3 scopes: sD9hP6nDDhG18GKSbLAb3: HTTPBearer: [] x-apifox-folder: Xiaohongshu-PGY-API x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-506372191-run components: schemas: NotesV2Req: properties: user_id: type: string title: User Id description: 博主用户ID/Blogger user ID examples: - 5c668b3e0000000012021605 page_number: type: integer maximum: 1000 minimum: 1 title: Page Number description: 页码，从 1 开始/Page number, from 1 default: 1 examples: - 1 page_size: type: integer maximum: 8 minimum: 1 title: Page Size description: 每页数量，1-8（蒲公英网页固定 8）/Page size, 1-8 (fixed at 8 on PGY web) default: 8 examples: - 8 note_type: type: integer enum: - 0 - 1 - 2 title: Note Type description: 笔记类型 0=全部类型(默认) 1=图文 2=视频/Note type default: 0 examples: - 0 order_type: type: integer enum: - 1 - 2 - 3 title: Order Type description: 排序 1=最新发布(默认) 2=阅读最多 3=互动最多/Sort default: 1 examples: - 1 additionalProperties: false type: object required: - user_id title: NotesV2Req x-apifox-orders: - user_id - page_number - page_size - note_type - order_type x-apifox-ignore-properties: [] x-apifox-folder: '' ResponseModel: properties: code: type: integer title: Code description: HTTP status code | HTTP状态码 default: 200 request_id: anyOf: - type: string - type: 'null' title: Request Id description: Unique request identifier | 唯一请求标识符 message: type: string title: Message description: Response message (EN-US) | 响应消息 (English) default: Request successful. This request will incur a charge. message_zh: type: string title: Message Zh description: Response message (ZH-CN) | 响应消息 (中文) default: 请求成功，本次请求将被计费。 support: type: string title: Support description: Support message | 支持消息 default: 'Discord: https://discord.gg/aMEAS8Xsvz' time: type: string title: Time description: The time the response was generated | 生成响应的时间 time_stamp: type: integer title: Time Stamp description: The timestamp the response was generated | 生成响应的时间戳 time_zone: type: string title: Time Zone description: The timezone of the response time | 响应时间的时区 default: America/Los_Angeles docs: anyOf: - type: string - type: 'null' title: Docs description: >- Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接 cache_message: anyOf: - type: string - type: 'null' title: Cache Message description: Cache message (EN-US) | 缓存消息 (English) default: >- This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again. cache_message_zh: anyOf: - type: string - type: 'null' title: Cache Message Zh description: Cache message (ZH-CN) | 缓存消息 (中文) default: >- 本次响应已缓存，可通过下方 URL 直接查看，有效期 24 小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。 cache_url: anyOf: - type: string - type: 'null' title: Cache Url description: The URL to access the cached result | 访问缓存结果的 URL router: type: string title: Router description: The endpoint that generated this response | 生成此响应的端点 default: '' params: type: string data: anyOf: - type: string - type: 'null' title: Data description: The response data | 响应数据 type: object title: ResponseModel x-apifox-orders: - code - request_id - message - message_zh - support - time - time_stamp - time_zone - docs - cache_message - cache_message_zh - cache_url - router - params - data x-apifox-ignore-properties: [] x-apifox-folder: '' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError x-apifox-orders: - detail x-apifox-ignore-properties: [] x-apifox-folder: '' ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: type: string ctx: type: object title: Context x-apifox-orders: [] properties: {} x-apifox-ignore-properties: [] type: object required: - loc - msg - type title: ValidationError x-apifox-orders: - loc - msg - type - input - ctx x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: HTTPBearer: type: bearer description: > ---- #### API Token Introduction: ##### Method 1: Use API Token in the Request Header (Recommended) - **Header**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: Click on the `Authorize` button in the upper right corner of the page to enter the API token directly without the `Bearer` keyword. ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only When Method 1 is Unavailable) - **Cookie**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `Authorization=Bearer your_token` #### Get API Token: 1. Register and log in to your account on the TikHub website. 2. Go to the user center, click on the API token menu, and create an API token. 3. Copy and use the API token in the request header. 4. Keep your API token confidential and use it only in the request header. ---- #### API令牌简介: ##### 方法一：在请求头中使用API令牌（推荐） - **请求头**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。 ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用） - **Cookie**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `Authorization=Bearer your_token` #### 获取API令牌: 1. 在TikHub网站注册并登录账户。 2. 进入用户中心，点击API令牌菜单，创建API令牌。 3. 复制并在请求头中使用API令牌。 4. 保密您的API令牌，仅在请求头中使用。 scheme: bearer servers: - url: https://api.tikhub.io description: Production Environment security: [] ```