axxell_api

AxxellApi - JavaScript client for axxell_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

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 axxell_api --save

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

var AxxellApi = require('axxell_api');

var defaultClient = AxxellApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-api-key'] = "Token"

var api = new AxxellApi.DefaultApi()

var storeid = "storeid_example"; // {String} Store identifier

var eventType = "eventType_example"; // {String} Valid values purchase, view or recommend

var dataPeriod = "dataPeriod_example"; // {String} Valid values are last7days, last30days, today, yesterday


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

Documentation for API Endpoints

All URIs are relative to https://axxell.cinaq.com/v1/

Class	Method	HTTP request	Description
AxxellApi.DefaultApi	aggregateCountEvents	GET /aggregates/countevents/{eventType}
AxxellApi.DefaultApi	aggregateEffective	GET /aggregates/effective/{eventType}
AxxellApi.DefaultApi	aggregateEvents	GET /aggregates/events/{eventType}
AxxellApi.DefaultApi	aggregateRecent	GET /aggregates/recent/{eventType}
AxxellApi.DefaultApi	aggregateTop	GET /aggregates/top/{eventType}
AxxellApi.DefaultApi	authStore	POST /auth
AxxellApi.DefaultApi	deleteAllEvents	DELETE /events
AxxellApi.DefaultApi	deleteAllItems	DELETE /items
AxxellApi.DefaultApi	deleteItem	DELETE /items/{itemid}
AxxellApi.DefaultApi	recommendInteresting	GET /recommendations/interesting
AxxellApi.DefaultApi	recommendSimilar	GET /recommendations/similar
AxxellApi.DefaultApi	registerEvent	POST /events
AxxellApi.DefaultApi	registerItem	POST /items
AxxellApi.DefaultApi	registerStore	POST /store
AxxellApi.DefaultApi	retrieveEvents	GET /events
AxxellApi.DefaultApi	retrieveItems	GET /items

Documentation for Models

• AxxellApi.DataPoint
• AxxellApi.ErrorResponse
• AxxellApi.Event
• AxxellApi.Item
• AxxellApi.Store

Documentation for Authorization

ApiKey

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Auto generated, see https://github.com/cinaq/axxell-specifications