Skip to content

第三方应用集成说明

概述

🎉各位开发者好~

集成前请仔细阅读该文档,有任何疑问请邮件690090@qq.com或微信w690090。

基本信息

  • 接口公共地址https://api.writeathon.cn
  • 请求信息格式JSON
  • 响应信息格式JSON

所有请求必须在请求头(request header)加入x-writeathon-token参数,其值为用户提供的集成Token(由用户自主生成),否则校验失败 集成Token为高级版功能,只有会员才能生成和使用

响应信息结构

参数说明
success请求状态,true/false
data返回数据(json对象),具体信息见各接口返回参数
action接口行为,具体信息见各接口信息
errorCode错误码,请求失败时返回,见错误码说明
message错误信息,请求失败时返回

错误码

错误码说明
1000未分类异常
1001没有高级版权限
1002没有提供集成Token
1003集成Token不存在
1004没有权限
1005项目不存在

接口

1. 获取用户基本信息

此接口为前置接口,后续接口需要用到此接口返回的用户id参数(建议存储该值)

1.1 接口信息

  • 接口地址/v1/me
  • 请求方式GET
  • 接口行为me

1.2 请求参数

1.3 返回参数

参数类型说明
id字符串用户id
username字符串用户名

2. 创建卡片

2.1 接口信息

  • 接口地址/v1/users/:id/cards:id为用户id
  • 请求方式POST
  • 接口行为create:添加时返回,append:追加时返回

2.2 请求参数

参数类型是否必填说明
title字符串卡片标题,若为空则自动创建,若存在则会追加内容到指定卡片,最大长度100个字符(1个中文字算1个字符)
content字符串卡片内容,最大长度5000个字符(1个中文字算1个字符)

2.3 返回参数

3. 获取最近更新的卡片列表

3.1 接口信息

  • 接口地址/v1/users/:id/cards/recent:id为用户id
  • 请求方式GET
  • 接口行为recent_card_list
  • 备注:返回最近修改的10个卡片列表,包括标题id信息

3.2 请求参数

参数类型是否必填说明
exclude_date_title布尔是否排除日期类型标题(一般为系统自动生成),默认为false

3.3 返回参数

返回对象数组类型,对象属性如下:

参数类型说明
_id字符串卡片id
title字符串卡片标题

4. 获取卡片

4.1 接口信息

  • 接口地址/v1/users/:id/cards/get:id为用户id
  • 请求方式POST
  • 接口行为get_card

4.2 请求参数

参数类型是否必填说明
title字符串title和id必填其一标题
id字符串title和id必填其一id

4.3 返回参数

返回对象类型,对象属性如下:

参数类型说明
_id字符串卡片id
title字符串卡片标题
content字符串卡片内容
created日期创建时间
updated日期更新时间