CS Corporate SDK for the WebApi Corporate Accounts
$ cnpm install cs-corporate-sdk 
SYNC missed versions from official npm registry.

#CSCorporateSDK This SDK allows you to access information about Česká spořitelna a.s. Corporate API Corporate API.



If you just want to use the SDK, there are compiled files ready to be used in the /dist folder.

You can just copy these files directly from the repository or preferably, use npm to install it into your project:

npm install https://github.com/Ceskasporitelna/cs-corporate-sdk-js.git --save

##Usage in browser For usage in browser, pickup the following files from the /dist folder:

  • cs-corporate-sdk.sfx.js - CSCorporateSDK packaged for browsers
  • cs-corporate-sdk.sfx.d.ts - CSCorporateSDK typings for browsers
  • cs-corporate-sdk.sfx.js.map - CSCorporateSDK sourcemap for browsers

Corporate SDK is dependent on the CSCoreSDK. You can find the appropriate verion of CSCoreSDK in node_modules of corporate SDK if you installed it through npm. Include the cs-core-sdk.sfx.js in your page before the cs-corporate-sdk.sfx.js:

  <script src="./node_modules/cs-corporate-sdk/node_modules/cs-core-sdk/dist/cs-core-sdk.sfx.js"></script>
  <script src="./node_modules/cs-corporate-sdk/dist/cs-corporate-sdk.sfx.js"></script>

The corporate SDK will be available in global variable CSCorporateSDK.

IMPORTANT! CSAS SDKs depend on a native ES6 Promise implementation to be supported. If your environment doesn't support ES6 Promises, you can polyfill.

##Usage in node For usage in node, install it through npm (see above). You can then require it by:

var CSCorporateSDK = require('cs-corporate-sdk');

##Configuration Before using any CSAS SDKs in your application, you need to initialize CSCoreSDK by providing it your WebApiKey.

CSCoreSDK.useWebApiKey( "YourApiKey" )
//Get the corporate client
var corporateClient = CSCorporateSDK.getClient();

See CoreSDK configuration guide for all the available configuration options.

##Usage Guide See Usage Guide for usage instructions.

#Development The SDK itself is written in TypeScript, packaged by webpack, tested by jasmine & karma and distributed thorugh npm. It uses tsd for TypeScript definitions.

In order to to develop upon this SDK, you will need the following installed globally:

  • node & npm
  • webpack - For packaging
  • karma - For testing
  • tsd - For downloading typescript definitions

##Setup After cloning the repo, run the following command to initialize the repository for development:

npm install && tsd install

You can verify everything worked as expected by running:

npm test

##Directory structure This project uses the following directory structure:

  • dist - Packaged version of this SDK ready for use.
  • build - Build artifacts (not checked in repository)
  • lib - The SDK itself
  • spec - Tests for the SDK
  • typings - Typings used by the SDK
  • tooling - Commands for building and packaging

##Development commands

  • npm run clean - cleans build and dist folders
  • npm run build - performs clean and builds the SDK into bulid folder. It also generates .d.ts files using generate-tsd command.
  • npm run dist - performs build command and copies the packaged SDK files into dist folder
  • npm run test - performs build and runs tests in node and browser.
  • npm run test-browser - performs tests only in browser
  • npm run test-node - performs tests only in node
  • npm version [major|minor|patch] - releases new version of the SDK. Requires write access to repository. See npm-version for more details.

#Contributing Contributions are more than welcome!

Please read our contribution guide to learn how to contribute to this project.

Terms & conditions

Please read our terms & conditions.

Current Tags

  • 1.0.1                                ...           latest (6 months ago)

2 Versions

  • 1.0.1                                ...           6 months ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Today 0
This Week 0
This Month 1
Last Day 1
Last Week 1
Last Month 2
Dependencies (11)
Dev Dependencies (15)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |