3scale-cm 中文文档教程

Question

3scale integration plugin for JavaScript/CoffeeScript/Node.js applications

3scale 是一种 API 基础设施服务，可处理 API 密钥、速率限制、分析、账单支付和开发人员管理。 包括可配置的 API 仪表板和开发人员门户 CMS。 http://www.3scale.net/ 上的更多产品资料，http://support.3scale.net/ 上的支持信息。

Installation

该模块通过包管理器 npm 交付，因此安装应该很简单：npm install 3scale

Requirements

从版本 0.6.0 开始，此插件需要使用 Node.js 版本 0.10.x或更高。

Synopsis

该插件支持对 3scale 后端的 3 种主要调用：

• authrep grants access to your API and reports the traffic on it in one call.
• authorize grants access to your API.
• report reports traffic on your API.

3scale 支持 3 种身份验证模式：App Id、User Key 和 OAuth。 前两个在调用后端时类似，它们支持 authrep。 OAuth 的不同之处在于它的用法需要两个调用：首先授权然后报告。

Usage

Authrep

Authrep 是一种“一次性”操作，用于授权应用程序并同时报告相关事务。 此调用与常规 authorize 调用的主要区别在于，如果授权成功，将报告使用情况。 在 3scale 的支持网站 的活动文档页面上阅读有关 authrep 的更多信息。

这是一个示例，假设您正在使用 app_id/app_key 身份验证模式：

var Client = require('3scale').Client;

client = new Client("your provider key",["3Scale URL(default : su1.3scale.net)"],["proxy URL"]);

client.authrep({"app_id": "your application id", "app_key": "your application key", "usage": { "hits": 1 } }, function(response){
  console.log(response);
});

如果您在 3scale 中配置了 API 身份验证以使用 user_key 模式，这将是等同于上面的示例：

var Client = require('3scale').Client;

client = new Client("your provider key");

client.authrep_with_user_key({ "user_key": "your key", "usage": { "hits": 1 } }, function(response){
  console.log(response);
});

Authorize and Report

您可以选择使用 authorize 和 report 方法在两个单独的调用中执行相同的操作。 请注意，report 方法支持在一次调用中发送多个事务的使用情况。

var Client = require('3scale').Client;

client = new Client("your provider key");

client.authorize({ "app_id": "your application id", "app_key": "your application key" }, function(response){
  if (response.is_success()) {
    var trans = [{ "app_id": "your application id", "usage": { "hits": 3 } }];
    client.report(trans, function (response) {
      console.log(response);
    });
  } 
  else {
    console.log("Error: " + response.error_code + " msg: " + response.error_msg);
  }
});

以下是 user_key 身份验证模式的相同示例：

var Client = require('3scale').Client;

client = new Client("your provider key");

client.authorize_with_user_key({ "user_key": "your key" }, function(response){
  if (response.is_success()) {
    var trans = [{ "user_key": "your key", "usage": { "hits": 3 }}];
    client.report(trans, function (response) {
      console.log(response);
    });
  } 
  else {
    console.log("Error: " + response.error_code + " msg: " + response.error_msg);
  }
});

请注意，report 方法支持在一次调用中发送多个事务的使用情况。

var trans = [
              { "app_id": "your application id", "usage": {"hits": 1}},
              { "app_id": "your application id", "usage": {"hits": 1000}}
             ]

client.report(trans, function(response){
  console.log(response);
});

OAuth

如果您在 3scale 中将 OAuth 设置为 API 的身份验证模式，则需要采用单独的authorize 和report 方法（即没有authrep 对于 OAuth）。

var Client = require('3scale').Client;

client = new Client("your provider key");

client.oauth_authorize({"app_id": "your application id"}, function(response){
  if (response.is_success()) {
    var trans = [{"app_id": "your application id", "usage": {"hits": 3}}];
    client.report(trans, function (response) {
      console.log(response);
    });
  } 
  else {
    console.log("Error: " + response.error_code + " msg: " + response.error_msg);
  }
});

To test

要运行测试：npm test 或 vows test/* --spec 来自项目的根目录。 请注意，您首先需要使用自己的 3scale 键设置以下环境变量：

• TEST3SCALEPROVIDER_KEY
• TEST3SCALEAPP_KEY
• TEST3SCALEAPP_ID