README
CSB HTTP-SDK for Javascript
该工具包提供前端通过 JS 方式调由 CSB 开放出来的数据服务接口.
安装
yarn add @digitalzz/csbsdk
使用
'use strict'
import { CSBClient } from '@digitalzz/csbsdk'
// 创建csbClient实例的时候如果传了ak、sk则不需要在请求参数里面传入
// 如果两个地方都有传入,则使用请求参数里面的ak、sk
const csbClient = new CSBClient(ak,sk) // ak: accessKey, sk: secretKey
// CSBClient请求示例(POST请求示例)
export const csbDemoRequest = async (url,params,headers) => {
var response = await csbClient.post(
url,
{
api: params.apiName, //api名称 (必传)
version: params.version, //api版本 (必传)
reqType: 'proxy' // api请求方式(必传: proxy:代理访问 / other:直接访问)
accessKey:params.accessKey, //accessKey 公钥 (非必传)
secretKey:params.secretKey, //secretKey 私钥 (非必传)
headers:{
...headers, // 自定义请求头参数信息
'Content-Type': 'application/json; charset=UTF-8' // 请求头类型 (必传)
},
data: { //post请求 (params.data)
...params.data, // 用户自定义查询键值对参数 (非必传)
queryValues: {} // 必传
}
},
)
console.log('response',response)
})
// CSBClient请求示例(GET请求示例)
export const csbDemoRequest = async (url,params,headers) => {
var response = await csbClient.get(
url,
{
api: params.apiName, //api名称 (必传)
version: params.version, //api版本 (必传)
reqType: 'proxy' // api请求方式(必传: proxy:代理访问 / other:直接访问)
accessKey:params.accessKey, //accessKey 公钥 (非必传)
secretKey:params.secretKey, //secretKey 私钥 (非必传)
headers:{
...headers, // 自定义请求头参数信息
'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8' // 请求头类型 (必传)
},
query: { // get请求 (params.query)
...params.query, // 用户自定义查询键值对参数 (非必传)
queryValues: '{}' // 必传
}
},
)
console.log('response',response)
})
// 获取GET请求的CSB请求头信息
const headerPayload = csbClient.getSignature({
apiName: 'digitalzz.user.query.info.enterprises_csb_cas',
version: '1.0.0',
query: {
accessToken: '121212121',
requireTotalCount: true,
queryValues: '{}'
}
})
console.log('headerPayload', headerPayload)
License
The MIT License