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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionComment | POST /api/FaceRecognition/Comment | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionComments | GET /api/FaceRecognition/Comments | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionComparison | GET /api/FaceRecognition/Comparison | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionComparisonList | GET /api/FaceRecognition/ComparisonList | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionFaceAddPost | POST /api/FaceRecognition/FaceAdd | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionFaceComparison | POST /api/FaceRecognition/FaceComparison | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionFaceDetectPost | POST /api/FaceRecognition/FaceDetect | Campaigncoreapisv3.FaceRecognitionApi | apiFaceRecognitionFaceSetPost | POST /api/FaceRecognition/FaceSet | Campaigncoreapisv3.GameAdminApi | adminGameApp | GET /Admin/Game/App | Campaigncoreapisv3.GameAdminApi | adminGameAttachment | POST /Admin/Game/Attachment | Campaigncoreapisv3.GameAdminApi | adminGameDelete | DELETE /Admin/Game/Delete | Campaigncoreapisv3.GameAdminApi | adminGameDeleteImage | DELETE /Admin/Game/Image | Campaigncoreapisv3.GameAdminApi | adminGameDeleteInstance | DELETE /Admin/Game/Instance | Campaigncoreapisv3.GameAdminApi | adminGameEdit | PUT /Admin/Game/Edit | Campaigncoreapisv3.GameAdminApi | adminGameEditImage | PUT /Admin/Game/Image | Campaigncoreapisv3.GameAdminApi | adminGameEditInstance | PUT /Admin/Game/Instance | Campaigncoreapisv3.GameAdminApi | adminGameGet | GET /Admin/Game/Get | Campaigncoreapisv3.GameAdminApi | adminGameImage | GET /Admin/Game/Image | Campaigncoreapisv3.GameAdminApi | adminGameInstance | GET /Admin/Game/Instance | Campaigncoreapisv3.GameAdminApi | adminGameInstances | GET /Admin/Game/Instances | Campaigncoreapisv3.GameAdminApi | adminGamePost | POST /Admin/Game/Post | Campaigncoreapisv3.GameAdminApi | adminGamePostImage | POST /Admin/Game/Image | Campaigncoreapisv3.GameAdminApi | adminGamePostInstance | POST /Admin/Game/Instance | Campaigncoreapisv3.GeneralApi | apiGeneralComment | POST /api/General/Comment | Campaigncoreapisv3.GeneralApi | apiGeneralDailyLimitShared | GET /api/General/DailyLimitShared | Campaigncoreapisv3.GeneralApi | apiGeneralEditDailyLimit | PUT /api/General/DailyLimit | Campaigncoreapisv3.GeneralApi | apiGeneralGameInstanceDetails | GET /api/General/GameInstanceDetails | Campaigncoreapisv3.GeneralApi | apiGeneralGeneralRanking | GET /api/General/GeneralRanking | Campaigncoreapisv3.GeneralApi | apiGeneralGetComment | GET /api/General/Comment | Campaigncoreapisv3.GeneralApi | apiGeneralGetDailyLimit | GET /api/General/DailyLimit | Campaigncoreapisv3.GeneralApi | apiGeneralImage | POST /api/General/Image | Campaigncoreapisv3.GeneralApi | apiGeneralIndividualRanking | GET /api/General/IndividualRanking | Campaigncoreapisv3.GeneralApi | apiGeneralPostDailyLimit | POST /api/General/DailyLimit | Campaigncoreapisv3.GeneralApi | apiGeneralPostGeneralRanking | POST /api/General/GeneralRanking | Campaigncoreapisv3.GeneralApi | apiGeneralStatisticData | POST /api/General/StatisticData | Campaigncoreapisv3.GeneralApi | apiGeneralUserInfo | GET /api/General/UserInfo | Campaigncoreapisv3.PosterApi | apiPosterGet | GET /api/Poster | Campaigncoreapisv3.PosterApi | apiPosterPost | POST /api/Poster | Campaigncoreapisv3.WechatApi | apiWechatCustomShare | GET /api/Wechat/CustomShare | Campaigncoreapisv3.WechatApi | apiWechatMiniProgramLogin | GET /api/Wechat/MiniProgramLogin | Campaigncoreapisv3.WechatApi | apiWechatMiniProgramSession | GET /api/Wechat/MiniProgramSession | Campaigncoreapisv3.WechatApi | apiWechatUserInfo | GET /api/Wechat/UserInfo |

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