api-park-docs神州问学文档中心

鉴权

鉴权说明。

鉴权介绍

为了提升 API 调用的安全性,神州问学设计了鉴权(API-Key)机制,调用 API 时,需要通过 API-Key 对调用者身份进行鉴权,即告知神州问学当前是谁、以什么身份获取什么租户的数据。

鉴权是接入神州问学 API 的钥匙,将应用获得的所有数据访问和接口调用权限绑定在一起,允许应用对资源进行读写操作。建议开发者在正式开发前对神州问学的鉴权机制有充分的了解。

鉴权字段

  • App ID:这是应用程序的唯一标识符,通常用于标识开发者或应用程序本身。它相当于用户的账号,帮助平台识别用户身份。在API接入过程中,App ID用于标识请求来自哪个应用程序,从而确保API调用的正确性和安全性。
  • API Key:这是一个公钥,用于验证API接入的合法性。可以将其视为登录网站的用户名。在API调用过程中,API Key用于证明请求者的身份,并允许其访问特定的API资源。

发送API请求时,需要将鉴权信息置于 HTTP 请求头中,以验证请求的合法性。

cURL
curl -X GET 'https://smartvision.digitalchina.com/open/opi-module/resource' \
--header 'App-Id: 1000000010' \
--header 'Api-Key: sk_AkwNFhmGuhFJ90iLutEArp5eICyZfx6Mi96yhU7Z3cBWM' 

获取方式

登录神州问学平台

登录神州问学平台,进入企业自建应用。 企业自建应用

创建企业自建应用

创建企业自建应用,赋予权限模块(如果已有应用,可跳过此步骤)。 创建自建应用

查看鉴权信息

查看应用详情,获取鉴权信息。 查看鉴权信息

常见问题和解决方法

错误代码可能的原因解决办法
401 Unauthorized无效的App Id或Api Key检查鉴权信息是否正确
403 ForbiddenApi Key权限不足检查API Key权限模块设置
400 Bad Request请求参数不正确查看API文档,确认请求格式和参数要求

目录