Skip to content

tsolucio/coreBOSWSAPIJS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 

Repository files navigation

coreBOS Webservice API Library for AngularJS

This AngularJS service gives us a high level abstraction layer to access all the power of the coreBOS application.

Following the layout defined by the rest of the coreBOS WebService API Libraries, this project gives us API calls in the form of javascript promises to all the functionality that can be found in the coreBOS application.

Documentation on the coreBOS WebService API can be found here and a full example of use can be studied in our AngularJS coreBOS Webservice API Browser Project.

This project is a proud member of the coreBOS family. Feel free to have a look and use as you may need and don't forget to come on over to our website for full details of the project and follow us on Google+ and LinkedIn for regular updates.

How to use:

####Install using Bower

bower install coreboswsapijs

####Add the JavaScript AFTER loading angularjs and before loading your main application script which will use the API

<script src="bower_components/angular-md5/angular-md5.min.js"></script>
<script type="text/javascript" src="bower_components/coreboswsapijs/coreBOSAPI.js"></script>

####Establish a connection to coreBOS with the coreBOSWSAPI.doLogin() call. For example, when loading your main application class

angular.module('coreBOSJSApp',
	[ ..., 'angular-md5', 'coreBOSAPIservice', ...])
...
	.run(function (coreBOSAPIStatus, coreBOSWSAPI) {
		//coreBOSWSAPI.setcoreBOSUser('your corebBOS user');
		//coreBOSWSAPI.setcoreBOSKey('your coreBOS Access key');
		coreBOSWSAPI.setURL('your coreBOS application URL');
		coreBOSWSAPI.doLogin('your corebBOS user','your coreBOS Access key').then(function() {});
	})

####Once you get a successful login you can call any API service and use the results in your application.

Dependencies:

This service requires MD5 calculation to prepare the hash pass code to connect to coreBOS. This dependency will be automatically installed for you if you use bower, but if you decide to do it manually you will have to load that service first.

You can load it with bower too:

bower install angular-md5

License

MPL 2.0