purecloud

Javascript wrapper round the PureCloud Platform API

Platform API Javascript Client

Docs can be found at http://developer.mypurecloud.com/api/rest/client-libraries/javascript/latest/

• Install with Bower:

bower install purecloud-api

or node

npm install purecloud

Source code https://github.com/MyPureCloud/purecloud_api_sdk_javascript

Using the Library

Referencing the modules in a web application

For convenience, all modules are bundled together, but if your application only uses a small subset of features, you can reference those modules directly.

Note: JQuery > 1.5 is required

Including the full Library:

<script type="text/javascript" src="purecloud-api.js"></script>

Including only a subset. It is important to note that PureCloud.core.js must be referenced first.

<script type="text/javascript" src="purecloudsession.js"></script>
<script type="text/javascript" src="usersapi.js"></script>

Referencing the modules in a NodeJS application

For NodeJS, helper methods are available for client credential grant authorization, usage is similar to the browser usage except that API classes are under the pureCloud object.

var pureCloud = require("purecloud");

var secret = process.env.PURECLOUD_SECRET;
var id = process.env.PURECLOUD_CLIENT_ID;

var pureCloudSession = new pureCloud.PureCloudSession();
pureCloudSession.authorizeWithClientCredentialsGrant(id, secret).done(function(){
    var authApi = new pureCloud.AuthorizationApi(pureCloudSession);
    authApi.getRoles().done(function(roles){
        //do something with the roles
    });
});

Authenticating in a Browser Application

Let the library handle the OAuth2 redirects for you.

var pureCloudSession = new PureCloudSession();
pureCloudSession.authorize('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX','http://localhost:8085/examples/')
                .done(function(){
    //this method will be called once we have a valid authorization token
    // if we don't have one a redirect to login will be called and then after redirecting back here,
    // the done method will be called.
});

If you already have a Bearer Token

If you already have a bearer token, you can specify it using

var pureCloudSession = new PureCloudSession();
pureCloudSession.setAuthToken("MYTOKEN");

Making Requests

Requests return the JQuery deferred object https://api.jquery.com/category/deferred-object/ so handlers can be registered to that response.

var usersapi = new UsersApi(pureCloudSession);
usersapi.getMe().done(function(userObject){
                                //successfully got the user object, do something with it here
                            }).error(function(){
                                //and error occurred getting /me
                            }).always(function(){
                                //this will be called for successes and failures
                            });