UNPKG

workplus-api

Version:
85 lines (55 loc) 1.56 kB
# WorkPlus API for Node.js [![NPM](https://nodei.co/npm/workplus-api.svg?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/workplus-api/) [![Build Status](https://travis-ci.org/xiaokaceng/workplus-api.svg?branch=master)](https://travis-ci.org/xiaokaceng/workplus-api) [![Coverage Status](https://coveralls.io/repos/github/xiaokaceng/workplus-api/badge.svg?branch=master)](https://coveralls.io/github/xiaokaceng/workplus-api?branch=master) [![David](https://david-dm.org/xiaokaceng/workplus-api.svg)](https://david-dm.org/xiaokaceng/workplus-api.svg) ## Install ``` $ npm install workplus-api --save ``` ## Usage 项目启动初始化模块 ``` let WorkPlus = require('workplus-api'); let workplus = new WorkPlus({ api: 'https://api3.workplus.io/v1', domain: 'atwork', key: 'xxxxx', secret: 'xxxxx', orgId: 'xxxxx' }); workplus.initAccessToken(); ``` #### API列表 - 初始化token ``` workplus.initAccessToken() ``` - 验证ticket ``` workplus.verifyTicket(ticket, clientId, orgId).then(function(data) { }).catch(function(e) { }) ``` - 上传图片 ``` workplus.uploadImage(file).then(function(data) { }).catch(function(e) { }) ``` - 拼装媒体下载地址 ``` workplus.assembleMediaDownloadURL(mediaId) ``` - 推送文本消息 ``` workplus.pushTextMessage(message).then(function(data) { }).catch(function(e) { }) ``` - 推送图文消息 ``` workplus.pushArticleMessage(message).then(function(data) { }).catch(function(e) { }) ``` ## License [MIT](LICENSE)