campaigncoreapisv3 v1.0.4

campaigncoreapisv3

Campaigncoreapisv3 - JavaScript client for campaigncoreapisv3 Swagger document This SDK is automatically generated by the Swagger Codegen project:

• API version: v1.0.2
• Package version: v1.0.2
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://portal.ixingban.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install campaigncoreapisv3 --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your campaigncoreapisv3 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('campaigncoreapisv3') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/campaigncoreapisv3 then install it via:

    npm install YOUR_USERNAME/campaigncoreapisv3 --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Campaigncoreapisv3 = require('campaigncoreapisv3');

var api = new Campaigncoreapisv3.FaceRecognitionApi()

var opts = { 
  'comment': new Campaigncoreapisv3.CommentModel() // {CommentModel} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiFaceRecognitionComment(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://campaigncore-gameresourcev3.chinacloudsites.cn

Documentation for Models

• Campaigncoreapisv3.AppModel
• Campaigncoreapisv3.BoolResult
• Campaigncoreapisv3.CommentModel
• Campaigncoreapisv3.FaceComparison
• Campaigncoreapisv3.GameImage
• Campaigncoreapisv3.GameInstance
• Campaigncoreapisv3.GameInstanceModel
• Campaigncoreapisv3.GameList
• Campaigncoreapisv3.GeneralRankingModel
• Campaigncoreapisv3.GeneralUploadImageModel
• Campaigncoreapisv3.IntResult
• Campaigncoreapisv3.MiniProgramSession
• Campaigncoreapisv3.PagingResultAppModel
• Campaigncoreapisv3.PagingResultCommentModel
• Campaigncoreapisv3.PagingResultFaceComparison
• Campaigncoreapisv3.PagingResultGameImage
• Campaigncoreapisv3.PagingResultGameInstance
• Campaigncoreapisv3.PagingResultGameList
• Campaigncoreapisv3.PagingResultGeneralRankingModel
• Campaigncoreapisv3.StatisticDataEntity
• Campaigncoreapisv3.StringResult
• Campaigncoreapisv3.UserInfo
• Campaigncoreapisv3.WechatCustomShare

Documentation for Authorization

AccessToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://ids.ixingban.com/connect/authorize
• Scopes:
  • openid: 用户标识
  • profile: 用户资料
  • campaign.core.apis.all: Game 2.0所有接口权限
  • campaign.core.identity.all: Identity所有接口权限

SubscriptionKey

• Type: API key
• API key parameter name: Ocp-Apim-Subscription-Key
• Location: HTTP header