jike-sdk Ⓙ 即刻 SDK

本项目仅供学习交流使用，在使用过程中对你或他人造成的任何损失我们概不负责。

Features

⭐️ 同时支持 Node.js / 浏览器 / Deno
🦾 自带 TypeScript 类型声明

API 列表

用户
- 获取用户信息
- 刷新 Access Token
- 发送登录验证码
- 短信登录
- 手机号与密码登录
- 保存设备 Token
用户关系
- 获取关注列表
- 获取被关注列表
动态
- 发送动态
- 获取动态详情
- 分享动态
- 点赞
- 取消点赞
评论
- 获取评论
- 发送评论
- 点赞
- 取消点赞
主页
- 获取用户动态
通知
- 获取通知列表
上传
- 获取上传 token
- 上传图片

Usage

API Reference

Node.js

Node.js >= 14.15.0 (推荐 v14.17.0 以上)

npm i jike-sdk

ESM 导入

如果使用 ESM 方式导入，需要把 package.json 的 type 设置为 module，或将后缀名改为 .mjs。

// 自带 node-fetch
import { api, setAccessToken, ApiClient } from 'jike-sdk/node'

// 不带 node-fetch，需要自行 ployfill
// import { api, setAccessToken, ApiClient } from 'jike-sdk'

setAccessToken('your access token')
api.userRelation.getFollowingList('82D23B32-CF36-4C59-AD6F-D05E3552CBF3', {
  limit: 100,
})

// Or
const client = ApiClient('your access token')
client.users.profile()

CJS 导入

;(async () => {
  const { setAccessToken, getAccessToken } = await import('jike-sdk/node')
  setAccessToken('your access token')
  console.log(getAccessToken())
})()

Deno

import { setAccessToken, api } from 'https://cdn.skypack.dev/jike-sdk?dts'

setAccessToken('your access token')
api.users.getSmsCode('+86', 'your mobile phone')

浏览器

import { setAccessToken } from 'jike-sdk'

setAccessToken('your access token')

或使用 CDN 的方式加载（与 Deno 一致）

<script type="module">
  import {
    setAccessToken,
    getAccessToken,
  } from 'https://cdn.skypack.dev/jike-sdk'
  setAccessToken('your access token')
  console.log(getAccessToken())
</script>

由于 CORS 策略的原因，第三方网站无法直接请求即刻服务器。但可以使用浏览器扩展的能力请求。

TODO

Support more low level APIs
Add some high level APIs

Alternatives

jike-cli - 即刻命令行客户端 (Java)
Jike Metro - 即刻 Ⓙ SDK (Python)
Jike-Bus - 🚍 即刻 Ⓙ SDK for Node.js
JIKEFM - 即刻电台 📻 (Golang)
jikeme - 命令行摸 🐟 工具 (Golang)