You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP

ordercloud-angular-sdk

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
O

ordercloud-angular-sdk

Wrapper for OrderCloud-Javascript-SDK

2.3.7
75

Supply Chain Security

100

Vulnerability

97

Quality

83

Maintenance

100

License

Repository has been archived by the owner.
Version published
Weekly downloads
5
400%
Maintainers
1
Weekly downloads
 
Created
Issues
9

OrderCloud Angular 1.xx SDK

This Angular 1.xx SDK is a wrapper for the OrderCloud Javascript SDK which is auto-generated from our Swagger Spec

Getting Started

If you're new to ordercloud check out our API documentation.

Additional SDK specific documentation can be found here

Installation

  • Type the following into a terminal window:
bower install ordercloud-angular-sdk --save
  • include the ordercloud-angular-sdk module as a dependency:
angular.module("YOUR_MODULE", ["ordercloud-javascript-sdk"])

Configuration

The SDK exposes OrderCloudSDK.Config to configure settings required to run. It receives the following parameters:

  • cookiePrefix // this determines what to prefix cookies as when saving them.
  • apiUrl // ordercloud.io base api url followed by the api version number (currently v1)
  • authurl // ordercloud.io base auth url

We recommend setting these in a run block like so:

angular.module("YOUR_MODULE", ["ordercloud-javascript-sdk"])
    .run(function(OrderCloudSDK){
        var cookiePrefix = "COOKIE_PREFIX_EXAMPLE"; // this can be any string - in the starter app we use the appname
        var apiVersion = "v1"; //there is currently only one version of the API
        var apiurl = "https://api.ordercloud.io"
        var authurl = "https://auth.ordercloud.io"

        OrderCloudSDK.Config(cookiePrefix, apiurl + '/' + apiVersion, authurl);
    })

Additional SDK Methods

In addition to the standard methods provided via the Javascript SDK, the following methods are added to allow you to interact with tokens (stored in cookies) for a user as well as an impersonated user.

OrderCloudSDK.GetToken();
OrderCloudSDK.SetToken(tokenToSet);
OrderCloudSDK.RemoveToken();

OrderCloudSDK.GetRefreshToken();
OrderCloudSDK.SetRefreshToken(tokenToSet);

OrderCloudSDK.GetImpersonationToken();
OrderCloudSDK.SetImpersonationToken(tokenToSet);
OrderCloudSDK.RemoveImpersonationToken();

Example

The following example will show you how to:

  • log in as a user
  • set the user's token in cookies
  • make an API call to retrieve user's details

var username = "user123";
var password = "foobar"
var clientid = "7FC87166-D42A-4F2D-9587-159D98156314" //you can find your app's client id in the [dashboard](https://dashboard.ordercloud.io/settings/options)
var scope = ["FullAccess"]; //this is an array of roles (permissions) being requested. More info on roles [here](https://documentation.ordercloud.io/platform-guides/authentication/security-profiles)


OrderCloudSDK.Auth.Login(username, password, clientid, scope)
    .then(function(response){
        var token = response["access_token"];
        OrderCloudSDK.SetToken(token); //this token is now stored in browser cookies and will be used on any subsequent API call
        OrderCloudSDK.Me.Get()
            .then(function(currentUser){
                console.log("This user's name is " + currentUser.FirstName + " " + currentUser.LastName);
            })
    })

Additional Information

Be sure to check out our API documentation.

Additional SDK specific documentation can be found here

FAQs

Package last updated on 24 Apr 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts