提供一站式软件研发管理工具

咚当奇哆 API

跟着奇哆一起去探索吧,哆~

基础路径

API BASE URL

  • https://qiduo-api.turka.cn

⛔旧api域名~duo-api-v2.turka.cn~目前已下架,请使用qiduo-api.turka.cn

角色投稿

很简单,欢迎大家来投稿吧(๑>▽<๑) https://www.wjx.top/vj/tsB1myp.aspx

温馨提示

🔑关于鉴权(非常重要)

为保障咚当奇哆的安全,调用本api前须申请appid,凭下发的appidapikey调用鉴权相关api(详见“鉴权”)获取token,并凭token调用本api。目前以下方式仅供参考,将以实际情况作调整。

appid的申请

内测中,暂未开放申请

appid将以申请单预留的联系方式私信下发,如下

appid:app10000
appkey325da...8d

appid的使用

调用咚当奇哆api时须通过鉴权相关api(详见“鉴权”)获取token,并自己定义一个名为AuthHTTP请求头,将获取到的token按以下格式放置在该请求头内

Auth: Bearer xxxxxxxxxxxxx

下面是调用咚当奇哆api的Python代码演示(使用requests库)

import requests

reqHeaders = {"Auth": "Bearer xxxxxxxxxxxxx"} # Auth的A必须是大写的,Bearer的B也是
req = requests.get ("https://qiduo-api.turka.cn/tuyafriends/1", headers = reqHeaders)

print (req.text)

限制

目前根据实际情况,每个appid的调用限制暂定为:4000次/天

📸关于图片资源

图片资源将由域名qiduo-cdn.turka.cn提供,须签名鉴权才可访问内部资源 咚当奇哆api可生成包含临时签名凭证的链接,可使用api生成的链接下载所需图片(链接有效期为五分钟

❌关于错误

咚当奇哆api返回的错误信息包括:错误码、消息、HTTP状态码、访问路径及时间戳,具体示例如下

{
  "code": 1002,
  "msg": "呜,找找没找到...",
  "status": 404,
  "path": "/tuyafriends/我不听",
  "time": 1666348897195
}

错误码 code 一览:

错误码描述
0成功
1000用户错误
1001未找到业务模块
1002未找到内容
1003管理员锁定
1004未提供token
1005拒绝访问
1006内容审核中
1007限制访问
1008appid或appkey错误
1009token已失效或错误
1010提交参数错误
2001QQ小程序登录失败
3000服务器开小差
3001系统繁忙
3002暂停服务

关于“管理员锁定”(1003):若角色处于出设状态、存在设定纠纷或出于保护设定等目的,管理员可能会将角色锁定屏蔽。

API REFERENCE

角色

在这里可以探索涂鸦小伙伴(角色)的一切,比如图片、角色设定等,合理利用会产生很多奇妙的效果!

🐈获取角色信息

获取指定角色的详情设定

get/tuyafriends/{text}
请求 Request

路由参数

  • textstring
    角色搜索信息,可以是角色ID、角色名、关键词等
响应 Response
成功返回
状态码 200

参数

  • idnumber

    角色ID

  • namestring
    string

    角色名称

  • birthdaystring
    string

    角色生日

  • hometownstring
    string

    角色出生地

  • gendernumber

    角色性别,1 = 男,0 = 女,2 = 无性,3 = 双性

  • animalstring
    string

    角色物种

  • chastring
    string

    角色性格

  • likesstring
    string

    角色喜好

  • introstring
    string

    角色简介、角色故事

  • collection_idnumber

    角色集合ID(正在开发中)

  • keywordarray

    角色关键词或小名列表

    • 数组成员string
    • string

      角色关键词或小名

  • imgsarray

    角色图片列表

    • 数组成员string
    • string

      角色图片id

错误返回
状态码 404

Example 1

请求示例

文本
get
{{BASE_URL}}/tuyafriends/string

成功示例

成功返回
1{
2  "code": 0,
3  "msg": "涂卡",
4  "status": 200,
5  "data": {
6    "id": 1,
7    "name": "涂卡",
8    "birthday": "2017-07-10",
9    "hometown": "涂卡邮局",
10    "gender": 1,
11    "animal": "邮箱猫猫",
12    "cha": "马虎可靠的孩子气",
13    "likes": "三明治、信封、外出探险、万圣节",
14    "intro": "瞧,这只是涂鸦宇宙里毛绒绒的小伙伴涂卡!涂卡曾经是个邮箱,所以偶尔会吞吞信件。涂卡尾巴还可以拉长长,看起来蛮好玩的~",
15    "collection_id": 1,
16    "keyword": [
17      "邮箱猫猫",
18      "涂涂",
19      "卡卡",
20      "turka"
21    ],
22    "imgs": [
23      "https://qiduo-cdn.turka.cn/data/17e7828157a.png?...",
24      "https://qiduo-cdn.turka.cn/data/17e7828157b.png?..."
25    ]
26  }
27}

失败示例

未找到角色
1{
2  "code": 1002,
3  "msg": "呜,找找没找到...",
4  "status": 404,
5  "path": "/tuyafriends/我不听",
6  "time": 1666348897195
7}

📸获取角色图片(未开放)

获取指定角色的随机一张图片的url地址

get/tuyafriends/{text}/img
请求 Request

路由参数

  • textstring
    角色搜索信息,可以是角色ID、角色名、关键词或是绑定的qid
响应 Response
成功返回
状态码 200

参数

  • idnumber

    角色ID

  • namestring
    string

    角色名称

  • imgstring
    string

    角色图片url

错误返回
状态码 403

Example 1

请求示例

文本
get
{{BASE_URL}}/tuyafriends/string/img

成功示例

成功返回
1{
2  "code": 0,
3  "msg": "成功",
4  "status": 200,
5  "data": {
6    "id": 1,
7    "name": "涂卡",
8    "img": "https://qiduo-cdn.turka.cn/data/17e7828157a.png?..."
9  }
10}

失败示例

无图返回
1{
2  "code": 1002,
3  "msg": "呜,找找的照片找丢了...",
4  "status": 404,
5  "path": "/tuyafriends/我不听/img",
6  "time": 1669289397527
7}

鉴权

需要通过相关api获取token才能正常调用咚当奇哆。

🔑获取token

通过appid和appkey获取token,以正常调用api

post/auth/token
请求 Request

请求 BODY

  • appidstring必填
    string

    下发的appid

  • appkeystring必填
    string

    下发的appkey

响应 Response
成功返回
状态码 200

参数

  • appnamestring
    string

    对应的应用名

  • tokenstring
    string

    token(调用凭证)

  • lifespannumber

    有效期(以秒为单位)

错误返回
状态码 403

Example 1

成功示例

文本
post
{{BASE_URL}}/auth/token

成功示例

成功返回
1{
2  "code": 0,
3  "msg": "成功",
4  "status": 200,
5  "data": {
6    "appname": "咚当奇哆",
7    "token": "xxxxxxxxxxxxx",
8    "lifespan": 43200
9  }
10}

失败示例

错误返回
1{
2  "code": 1008,
3  "msg": "appkey错误",
4  "status": 403,
5  "path": "/auth/token",
6  "time": 1666348897195
7}
© 2022 深圳市腾云扣钉科技有限公司 | 粤ICP备14029750号-1