SDK 初始化鉴权

简介

HI,您好,欢迎使用学而思网校AI开放平台SDK初始化鉴权接口服务。

本文档主要针对需要集成HTTP API的技术研发工程师,详细描述SDK初始化鉴权能力相关的技术内容。您可以通过快速接入安全接入使用此AI能力。

接口能力

接口名称 接口能力简要描述 api 地址
SDK初始化鉴权 SDK初始化鉴权 http://openapiai.xueersi.com/v1/api/sdk/auth/init

适用范围

任意操作系统,任意编程语言,均可以通过http或https调用本接口。

请求方式

HTTP 方法POST

请求 URLhttp://openapiai.xueersi.com/v1/api/sdk/auth/init

注意: Content-Type为application/x-www-form-urlencoded,然后通过urlencode格式化请求体。

Header 如下

参数名 赋值
Content-Type application/x-www-form-urlencoded

 

urlencode介绍

在请求 API 的 post 请求参数中含有图片url地址或base64字符。url地址 或 base64 字符作为参数传递时,需要把 中文 以及 '/' 做一下编码,防止解析中出现歧义,从而符合url的规范。

将中文 以及 '/'  转换为百分号编码形式,这就是 urlencode 格式化操作

部分语言的第三方包内部做了 urlencode 编码,不进行 urlencode 格式化也可以正常进行 API 请求,但    是进行 urlencode 格式化之后一定可以通过请求。所以我们推荐您对请求体中的参数进行 urlencode 操作

 

快速接入方式

请求参数详情

参数名 类型 是否必选 赋值说明 样例 备注
app_key string 应用标识 8102b22a5e81e840176d9f381ec6f837  
package_name string 包名 包名  
platform string 平台 android | ios | pc  

请求代码示例

HTTP 代码示例:

POST /v1/api/sdk/auth/init HTTP/1.1
Host: openapiai.xueersi.com
Content-Type: application/x-www-form-urlencoded
User-Agent: PostmanRuntime/7.19.0
Accept: */*
Cache-Control: no-cache
Postman-Token: c7bdaf1b-587f-4b50-b9cb-9847b25f704b,77df1668-e4e3-404d-86b3-3337f0e1a49b
Host: openapiai.xueersi.com
Accept-Encoding: gzip, deflate
Content-Length: 74
Cookie: X-Request-Id=6eb8a021da5e474a91237d3f2ca46c56; stu_area_id=11; aliyungf_tc=AQAAAPh6oUlovAAA1mK4NJS2lR4Z9km+
Connection: keep-alive
cache-control: no-cache

app_key=8102b22a5e81e840176d9f381ec6f837&package_name=pck&platform=android

cURL 代码示例:

curl -X POST \
  http://openapiai.xueersi.com/v1/api/sdk/auth/init \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 74' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Cookie: X-Request-Id=6eb8a021da5e474a91237d3f2ca46c56; stu_area_id=11; aliyungf_tc=AQAAAPh6oUlovAAA1mK4NJS2lR4Z9km+' \
  -H 'Host: openapiai.xueersi.com' \
  -H 'Postman-Token: c7bdaf1b-587f-4b50-b9cb-9847b25f704b,0ccfe9b7-f8bc-411d-b096-30c93c508502' \
  -H 'User-Agent: PostmanRuntime/7.19.0' \
  -H 'cache-control: no-cache' \
  -d 'app_key=8102b22a5e81e840176d9f381ec6f837&package_name=pck&platform=android'

安全接入方式

请求参数详情

参数名 类型 是否必选 赋值说明 样例 备注
app_key string 应用标识 8102b22a5e81e840176d9f381ec6f837  
time_stamp string 秒级时间戳 1493468759 安全接入必备,用于唯一地标识某一刻的时间
nonce_str string 随机字符串 dd599ef889859f9fe 安全接入必备
sign string 签名信息 99880aabb33f4def5c875875b6bdc3b1 安全接入必备
package_name string 包名 包名  
platform string 平台 android | ios | pc  

请求代码示例

HTTP 代码示例:

POST /v1/api/sdk/auth/init HTTP/1.1
Host: openapiai.xueersi.com
Content-Type: application/x-www-form-urlencoded
User-Agent: PostmanRuntime/7.19.0
Accept: */*
Cache-Control: no-cache
Postman-Token: 91b80eff-7643-4cf0-bfe6-f9c2e2372b7f,aed80690-a867-4a46-a64a-da3599832a99
Host: openapiai.xueersi.com
Accept-Encoding: gzip, deflate
Content-Length: 161
Cookie: X-Request-Id=6eb8a021da5e474a91237d3f2ca46c56; stu_area_id=11; aliyungf_tc=AQAAAPh6oUlovAAA1mK4NJS2lR4Z9km+
Connection: keep-alive
cache-control: no-cache

app_key=8102b22a5e81e840176d9f381ec6f837&package_name=pck&platform=android&time_stamp=1551174536&nonce_str=W8FI8oCp&sign=bf045ed767c232ad95b1926cfc938dc681aabb9e

cURL 代码示例:

curl -X POST \
  http://openapiai.xueersi.com/v1/api/sdk/auth/init \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 161' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Cookie: X-Request-Id=6eb8a021da5e474a91237d3f2ca46c56; stu_area_id=11; aliyungf_tc=AQAAAPh6oUlovAAA1mK4NJS2lR4Z9km+' \
  -H 'Host: openapiai.xueersi.com' \
  -H 'Postman-Token: 91b80eff-7643-4cf0-bfe6-f9c2e2372b7f,0af694ac-9bb2-4059-bd41-b452bff6319f' \
  -H 'User-Agent: PostmanRuntime/7.19.0' \
  -H 'cache-control: no-cache' \
  -d 'app_key=8102b22a5e81e840176d9f381ec6f837&package_name=pck&platform=android&time_stamp=1551174536&nonce_str=W8FI8oCp&sign=bf045ed767c232ad95b1926cfc938dc681aabb9e'

返回响应

返回格式

JSON格式

响应参数说明

参数名 类型 赋值说明 样例 备注
code int 返回码 0  
msg string 返回码解释 "请求成功"  
data obj 识别结果结构    

响应代码示例

响应Body:

{
  "code": 0,
  "msg": "请求成功",
  "data": null
}


// sdk过期
{
    "code": 25003,
    "msg": "SDK过期",
    "data": null
}

常见问题及反馈

Back to top