@3cplus/3cplusv2-sdk 中文文档教程

Question

3Cplus SDK JS

内部使用的 SDK 用于联系 3cplusv2 的 api 和套接字，公开一致且可重用的接口。

Installation

yarn add 3cplusv2-sdk-js --save

Usage

import TcSDK from '3cplusv2-sdk-js'

// The constructor receives the same options as axios.create
const sdk = new TcSDK({
  baseURL: "https://app.3c.fluxoti.com"
})
.v1()
.withAuth('your_api_token_here')

// Http Api
sdk.user().me()
.then((response) => console.log(response.data))
.catch((err) => console.log(err.response.data))

// Realtime integration events
sdk = sdk.websocket('wss://events.3c.fluxoti.com/ws/me')
const events = sdk.events()

events.on('open', () => console.log('Connected'))
events.on('close', () => console.log('Connection closed'))
events.on('error', err => console.log(err))
events.on('message', evt => console.log(evt))
events.on('event-name-here', evt => console.log(evt))

// Realtime events (legacy)
sdk = sdk.socket('https://socket.3c.fluxoti.com')
const socket = sdk.realtime().integration()

socket.on('connect', (event) => console.log('Listening for events'))
socket.on('integration', (event) => console.log(event))
socket.on('error', (err) => console.log(err))

所有可用的 api 端点都在 .vX() 下，由部分分隔。 每个方法都返回一个 axios promise。

请参阅 Api 文档 以获取有关请求参数、响应和错误的约定的更多信息。