Theme switcher

Nox聚星API指引

Nox聚星API介绍

Nox聚星API基于REST进行开发,提供可预测且面向资源的URL,接受JSON编码的请求体,返回JSON编码的响应,并使用标准的HTTP响应代码。

我们提供的强大且灵活的应用程序接口(API),支持开发者获取主流社交媒体的统计数据和分析数据。支持用户定制数据接口和字段。

如需了解更多关于Nox聚星的产品和服务,你可以访问noxinfluencer.com,或者联系我们的客户经理了解。

为什么需要使用Nox聚星API

通过我们的API,开发者可以快速获取对其业务有帮助的高价值数据,与其内部系统或者应用进行数据对接。无需要自行去每个平台中逐一搜集。无论是数据获取还是数据分析,都可以借助我们精心设计的API接口来实现。我们的API提供深入且精确的统计信息与分析结果,可以帮助你更好地理解社交媒体市场的运行状况,根据数据进行有针对性的策略调整。

如何调用Nox聚星API

对于有API数据服务需求的开发者,需要与我们的客户经理对接并明确数据需求,开发者将收到相应的数据方案和报价计划。

双方确认无误后,我们将为您配置专有的Nox Key,并按照以下文档内容,正确使用Nox聚星API接口即可。

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://service.noxinfluencer.com

Language Box

Was this section helpful?

What made this section unhelpful for you?

Data format-数据格式

数据

格式说明

Timestamps

Date and time with timezone information in yyyy-MM-ddTHH:mm:ss.SSS+0800 format, The time zone is Asia/Shanghai.

时间戳:日期和时间格式以yyyy-MM-ddTHH:mm:ss.SSS+0800展现,如Asia/Shanghai.

Country Codes

Two-letter ISO 3166-2 country code.

国家代码格式以 ISO 3166-2 为准

Language Codes

Two-letter ISO 639-1 language codes.

语言代码以ISO 639-1为准

Currency Codes

Three-letter ISO 4217 currency code.

货币代码以ISO 4217 为准

Was this section helpful?

What made this section unhelpful for you?

Code message-状态码提示

状态码

提示信息

描述

10000

success

成功

20000

server not available

无服务

20001

insufficient authorization

权限不足

30001

month's channel limit reached

达月度配额上限

40001

missing required parameters

请求参数缺失

40002

invalid parameter

无效参数

40003

invalid noxKey

无效noxKey

40004

source not found

频道不存在

40005

no quota available

配额不足

40007

result exceeds max size

结果超出最大限额

40008

channel requested is not found

频道未收录

50000

business processing failure

业务处理失败

50001

request rate is too fast

请求过快

Was this section helpful?

What made this section unhelpful for you?

YouTube

支持开发者通过YouTube相关接口,获取YouTube网红频道、YouTube网红视频、YouTube视频评论数据。

TikTok

支持开发者通过TikTok相关接口,获取TikTok网红频道、视频及视频评论数据。

Instagram

支持开发者通过Instagram相关接口,获取Instagram网红账号、视频及视频评论数据。

Facebook

支持开发者通过Facebook相关接口,获取Facebook网红频道、视频及视频评论数据。

Was this section helpful?

What made this section unhelpful for you?

Channel data

频道信息支持通过账号唯一标识id获取其账号的相关信息。

Query Parameters

noxKeystring Required

noxKey

channelIdstring Required

账号唯一标识符id

Response

200
Object

Response Attributes

codenumber Required

接口返回状态码

msgstring Required

状态码简单描述

itemsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/nox/v1/facebook/profile?noxKey=&channelId=

Select
1 curl --location 'https://service.noxinfluencer.com/nox/v1/facebook/profile?noxKey=&channelId=' \

Response

{
  "code": 10000,
  "msg": "Success",
  "items": [
    {
      "id": "12345",
      "title": "Hello World",
      "url": "https://www.example.com",
      "avatar": "https://www.example.com/avatar.png",
      "subscribers": 1000,
      "followings": 500,
      "alias": "ExampleUser",
      "category": "Technology",
      "authenticationStatus": true,
      "privateStatus": "false",
      "socialMediaLink": [
        {
          "platformName": "Twitter",
          "link": "https://twitter.com/example"
        },
        {
          "platformName": "Instagram",
          "link": "https://www.instagram.com/example"
        }
      ],
      "contactInfos": [
        {
          "name": "Email",
          "value": "example@example.com"
        },
        {
          "name": "Phone",
          "value": "1234567890"
        }
      ],
      "introduction": "I am a technology enthusiast.",
      "address": "123 Example Street, City, Country",
      "gender": "Male",
      "country": "US",
      "totalLikes": 5000,
      "registerDate": "2021-01-01T00:00:00+08:00",
      "updateTime": "2021-02-15T12:34:56+08:00"
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Video data

支持通过网红频道ID获取账号所发布的视频相关数据。

Query Parameters

noxKeystring Required

noxKey

channelIdstring Required

账号唯一标识符id

pageNumstring

页码

pageSizestring

每页条数

Default value
10
startDatestring

视频发布时间开始时间(yyyy-MM-dd)

endDatestring

视频发布时间结束时间(yyyy-MM-dd)

Response

200
Object

Response Attributes

codenumber Required

接口返回状态码

msgstring Required

状态码简单描述

pageInfoobject Required

Show child attributes

itemsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/nox/v1/facebook/video?noxKey=&channelId=&pageNum=&pageSize=&startDate=&endDate=

Select
1 curl --location 'https://service.noxinfluencer.com/nox/v1/facebook/video?noxKey=&channelId=' \

Response

{
  "code": 10000,
  "msg": "Success",
  "pageInfo": {
    "totalResults": 30,
    "resultsPerPage": 30,
    "currentPage": 1
  },
  "items": [
    {
      "id": "12345",
      "title": "My Awesome Video",
      "publishTime": "2021-01-01T08:00:00.000+0800",
      "updateTime": "2021-01-02T10:00:00.000+0800",
      "comments": 500,
      "shares": 100,
      "url": "https://www.example.com/video",
      "language": "en",
      "country": "US",
      "videoType": "0",
      "duration": 10.5,
      "liveViewerCount": 1000,
      "thumbnail": "https://www.example.com/thumbnail.jpg",
      "likes": 1000,
      "reaction": [
        {
          "type": 1,
          "value": 53
        },
        {
          "type": 5,
          "value": 48
        },
        {
          "type": 4,
          "value": 3
        },
        {
          "type": 7,
          "value": 1
        }
      ],
      "views": 10000,
      "totalVideoPosts": 50,
      "description": "This is a tutorial video on how to do something amazing.",
      "tags": [
        "tutorial",
        "amazing",
        "example"
      ],
      "authorName": "John Doe",
      "authorAvatar": "https://www.example.com/avatar.png",
      "authorUrl": "https://www.example.com/author"
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Comment data

根据视频id获取对应视频的评论信息。

Query Parameters

noxKeystring Required

noxKey

videoIdstring Required

内容唯一标识id

pageNuminteger

页码

Default value
1
pageSizeinteger

每页条数

Default value
30

Response

200
Object

Response Attributes

codenumber Required

接口返回状态码

msgstring

状态码简单描述

pageInfoobject Required

Show child attributes

itemsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/nox/v1/facebook/comments?noxKey=&videoId=&pageNum=&pageSize=

Select
1 curl --location 'https://service.noxinfluencer.com/nox/v1/facebook/comments?noxKey=&videoId=' \

Response

{
  "code": 10000,
  "msg": "Success",
  "pageInfo": {
    "totalResults": 30,
    "resultsPerPage": 30,
    "currentPage": 1
  },
  "items": [
    {
      "id": "11111111111",
      "authorId": "100064557677996",
      "authorName": "政客爽",
      "authorGender": "male",
      "authorUrl": "https://www.facebook.com/PoliticianSong",
      "publishTime": "2023-07-20T18:02:42.000+0800",
      "comment": "好感人",
      "thumbnails": "https://res-kol.noxgroup.com/noxinfluencer/facebook/video/thumbnails/c491195a14bafe044cf15bb2598eec20.png",
      "likes": 315,
      "replayCount": 24,
      "url": "https://www.facebook.com/PoliticianSong/posts/pfbid0iE1EcSiDpVo5Whn2fs9ti8FXVQYTbGakzoE9zEshmpGtEqGFbgdLUfzWQMu3T3U6l?comment_id=1458469374969295",
      "videoUrl": "https://www.fa",
      "videoId": "111111111"
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Twitter

支持开发者通过Twitter相关接口,获取Twitter网红频道、视频及视频评论数据。

NaverBlog

undefined

Rate limit-速率限制

为保证服务稳定性,单个Nox Key的请求速率限制为60次/分钟。

Was this section helpful?

What made this section unhelpful for you?

API测试样例

API测试方法

  1. 开放者可以在右上角点击“API测试”,或者在每个接口中点击“Try in API explorer”
  2. 您可以使用以下列出的demo noxKeychannelId进行测试。

Nox key

NOXKOLdZ1mACJlFeskFxJqeR2LjxCXYp6R

YouTube channel id

UCq-Fj5jknLsUf-MWSy4_brA

UCX6OQ3DkcsbYNE6H8uQQuVA

UC3IZKseVpdzPSBaWxBxundA

UCOmHUn--16B90oW2L6FRR3A

UC-lHJZR3Gqxm24_Vd_AJ5Yw

Instagram channel id

25025320

173560420

427553890

460563723

12281817

TikTok channel id

127905465618821121

5831967

6748458643983238149

6614519312189947909

107955

Was this section helpful?

What made this section unhelpful for you?

更新记录

2023-12-19

Twitter增加Convert URL接口

2023-11-23

YouTube视频数据请求参数,每页返回结果数量从30调整至10

Instagram视频数据请求参数,每页返回结果数量从30调整至10

TikTok视频数据请求参数,每页返回结果数量从30调整至10

Facebook视频数据请求参数,每页返回结果数量从30调整至10

Twitter视频数据请求参数,每页返回结果数量从30调整至10

Was this section helpful?

What made this section unhelpful for you?