simboss-nodejs-sdk v1.0.2

SIMBOSS-SDK

概述

本项目是SIMBOSS服务平台API接口调用的封装。

引入

从 npm 安装

这是我们建议的方式

$ npm install simboss-nodejs-sdk

从 git 库下载

你可以直接用 git clone 下载源代码来使用。但是请注意非 master 分支的代码可能会变更，应谨慎使用。

使用

开始

项目仅支持node-v6.14.3及其以上的版本，低于该版本的node环境无法运行。

初始化

• 你可以直接调用构造函数进行初始化，同时也可以调用初始化函数进行初始化

	const simbossSdkLib = require('simboss-nodejs-sdk');
	// 你可以使用调用构造函数的方法
	const simbossSdk = new simbossSdkLib({
			appid: 'you appid',
			secret: 'you secret'
		})
	// 也可以使用init来进行初始化
	const simbossSdk = simbossSdkLib.init({
			appid: 'you appid',
			secret: 'you secret'
		})

• 初始化参数

调用

• 我们的代码对方法的封装基于Promise的风格进行，可以支持所有用promise实现的调用。

代码将返回一个promise对象。你可以使用异步调用来决议或者自行决议。 不支持回调风格，如需使用，请自行封装。

1、promise

	Instance.name.action(data).then(data=>{
			// your process
		}).catch(e=>{
			// err process
		})

2、async/await

	async (data) => {
		try{
			let rst = await Instance.name.action(data)
			if (rst.code) {return false}
			//your process
		} catch (e) {
			// err process
		}
	} 

• 如果返回值的code不为0，请自行根据 SIMBOSS-API 接口规范-参数规范 进行封装。

方法

所有方法基于 SIMBOSS-API 进行封装。传入的参数和API内容中的参数保持一致。具体参数传递规范和要求见api文档规范

• Instance代表你自己初始化的实例对象
• 传入为含有请求参数字段的一个对象