Authenticating Using OAuth

Authenticating Using OAuth

Introduction

The platform currently supports OAuth authentication using either the client credential or authorisation code grant types.


Please see  https://oauth.net/2/grant-types/  for more details on the various OAuth grant types.
With both grant types, the end result is an access token that should be included in the Authorization header for API calls.

Creating an OAuth User

Before authenticating, it is necessary to create an OAuth user.

This can be achieved by clicking on the "Create OAuth User" button in User Manager.



The available scopes can be seen in the "System Permissions" section for each user and are referred to as "Resources". The scope name is displayed in light grey underneath the resource title.

Using the Client Credentials Grant


When the client credentials grant is used, API calls will only have access to the resources (companies, users, system permissions etc.) enabled for the OAuth user in question. 

An access token can be produced by sending a POST request to the OAuth token endpoint.

For example:

  1. curl -F"client_id=..." -F"client_secret=..." -F"grant_type=client_credentials" -F"scope=..." https://oauth.custom-gateway.net/token
A successful request will return a JSON encoded object with an access_token field.

Using the Authorization Code Grant


When the authorisation code grant is used, API calls will have access to all resources that the authorising user has access to with the exception of system permissions, which are determined based on the intersection between the OAuth user and the authorising user. 

Many online tools such as Zoho Analytics and Zapier make use of the authorization code grant.

When using such tools use the following values:




    • Related Articles

    • Adding prices using Dynamic pricing

      Below is a way of adding your prices on garment using dynamic pricing.   This section is found in each product's 'e-commerce' tab  Base price = RRP (inc tax) in eCommerce section of CPP. Print Areas = Price Per Print Area in eCommerce section of CPP. ...
    • Using the standard list Job sheet

      To use standard list Job sheet with batching there are two thing that must be done.   On the users company under advanced settings they must have  Improved Document Generation Rules checked.     On the dropship (secondary) company under advanced ...
    • Using a Save Project Module in Magento

      Users can save their designs in the front end of a magento websites and can return back to their design at a later time to complete their designs if they want. This is possible by installing the 'save project module' on magento.  This module allows ...
    • 3d Products | Using Pattern Images with a 3d Product

      This article will cover the process of adding patterned images to 3d models and ensuring that the pattern is displayed at the correct scale. These instructions will assume an intermediate knowledge of Photoshop but the principles will apply to any ...
    • How to import configurable products using Magnetic One

      To import a configurable product using Magnetic One please add the following fields to your spreadsheet Configurable Products <configurable> - should have all sku of associated products Configurable Products (attribute) <configurable_attribute> - ...