4 Star 0 Fork 0

巨量云 / juliang-nodejs-sdk

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

巨量IP API SDK - Node.js

通过SDK可快速调用巨量IP支持的API接口, 查看详情

简介

巨量IP - Api SDK (NodeJs 版本)

依赖环境

  1. sync-request

    npm install sync-request
  2. express (运行测试案例时需要安装,如果不需要测试则无需安装)

    npm install express
  3. 巨量IP购买相应的产品

  4. 获取订单的trade_no(业务号) 和对应的 Key(业务秘钥)

获取安装

安装nodeJs SDK之前, 请先获取订单所对应的业务编号(trade_no)和业务对应的秘钥(Key). 订单编号时用于识别具体业务订单, Key 则是用于加密签名字符串和服务器端用于验证签名一致性的秘钥. 因此,业务秘钥必须严格保管,避免泄露,一旦泄露,请立即前往个人中心 ——>产品管理 页面进行对应业务订单的秘钥重置.

通过npm安装(推荐)

您可以通过npm将SDK安装到您的项目中:

npm install juliangip

如果您的项目环境未配置npm,可前往NodeJs 官网下载并安装合适的NodeJs版本,然后可参考下方示例进行安装:

  • Ubuntu 安装npm :

    1.获取安装源,在终端中执行
    curl -sL https://deb.nodesource.com/setup_17.0.1 | sudo -E bash -
    2.等待源添加完毕后在执行
    sudo apt-get install -y nodejs
    3.验证安装
    node -v:查看node版本
  • CentOS安装npm :

    1.使用wget拉取源文件
    wget https://npm.taobao.org/mirrors/node/v17.0.1/node-v17.0.1-linux-x64.tar.gz
    2.执行tar -zxvf 执行解压缩命令
    tar -xvf node-v17.0.1-linux-x64.tar.gz
    3.验证安装
    node -v:查看node版本
  • MacOS安装npm :

    1.打开终端,执行以下命令安装Homebrew
    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    2.安装node
    brew install node   //sudo 使用admin权限
    3.验证安装
    node -v:查看node版本

通过源码安装

前往Gitee代码托管地址 巨量云 - NodeJs-sdk 下载最新的代码,解压后放置在需要使用的工程目录下即可

启动命令

$ cd sdk
$ npm i sync-request
$ npm i express
$ node API/server.js (执行开启http端口监听的js文件)

示例

/**
 * juliang --node sdk使用示例
 * @author http://www.juliangip.com
 */
//导入 Node.js Web 应用程序开发框架 -- express
const express = require('express');
const app = express();
//导入巨量IP -- sdk
const juliang = require('juliangip');
//创建Api服务调用对象client
const client = new juliang.client();

var result = ''; //用于接收返回值的参数

//初始化服务调用所需公共必要参数
const user_id = '用户ID';
const accessKey = 'API秘钥';
const dyTradeNo = "动态代理 -- 业务编号";
const dyKey = "业务秘钥";

//启动程序监听3600端口<如端口冲突 , 可自行修改端口>
app.listen(3600,()=>{
    console.log('server start --> port : 3600')
})

app.get('/',(req,resp)=> {
    resp.send('巨量IP API 示例')
})

app.get('/users/balance',(req,resp)=>{
    /**
	 * 公共接口 -- 获取账户余额
	 * @param {userId,AccessKey} {用户ID,秘钥}
 	 * @param {HTTP请求方式} method 
	 */
	result = client.userBalance({userId: user_id,AccessKey: accessKey});
	console.log(result);
	resp.send(result);
    
})

app.use('/dynamic/getIps',(req,resp)=> {
    /**
	 * 动态代理 -- 提取代理IP示例
	 * @param {业务秘钥} key <必传参数>
     * @param {业务号} trade_no <必传参数>
     * @param {提取数量} num <必传参数>
     * @param {可选参数
     *  pt : 代理类型,
     *  result_type : 返回类型('text' | 'json' | 'xml')
     *  split : 结果分隔符,
     *  city_name : 地区名称,
     *  city_code : 邮政编码,
     *  ip_remain : 剩余可用时长,
     *  area : 筛选地区,
     *  no_area : 排除地区,
     *  ip_seg : 筛选IP段,
     *  no_ip_seg : 排除IP段,
     *  isp : 运营商筛选,
     *  filter : IP去重
     * } otherParams <可选参数>
     * @param {HTTP请求方式} method 
	 */
	result = client.dynamicGetIps(dyKey,dyTradeNo,5,{pt: 2,result_type: 'json',city_name: 1});
	console.log(result);
    resp.send(result);
})

您可以在API下的server.js 文件中找到完整的示例

参考资料

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

巨量IP - API SDK for NodeJS 展开 收起
JavaScript
Apache-2.0
取消

发行版 (3)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/juliangip/juliang-nodejs-sdk.git
git@gitee.com:juliangip/juliang-nodejs-sdk.git
juliangip
juliang-nodejs-sdk
juliang-nodejs-sdk
master

搜索帮助