hl_connector

HlConnector - JavaScript client for hl_connector HL Connector provides a simplified API interface to Hal Leonard's Digital Asset Management (DAM) system. This API enables vendors to integrate with Hal Leonard's digital content distribution platform to purchase registrations, download, and manage digital sheet music and other media assets This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.2
• Package version: 0.2
• Generator version: 7.18.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install hl_connector --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your hl_connector from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/HLConnect/hlconnect-javascript then install it via:

    npm install HLConnect/hlconnect-javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var HlConnector = require('hl_connector');

var defaultClient = HlConnector.ApiClient.instance;
// Configure Bearer access token for authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.accessToken = "YOUR ACCESS TOKEN"

var api = new HlConnector.AssetsApi()
var opts = {
  'pageSize': 20, // {Number} Number of assets to return per page
  'lastId': 56 // {Number} The ID of the last asset from the previous page. Used for pagination to retrieve the next page of results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assetsList(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://hlconnect-api.mu.se

Class	Method	HTTP request	Description
HlConnector.AssetsApi	assetsList	GET /assets/list	Retrieve a paginated list of digital assets
HlConnector.HealthApi	health	GET /health	Perform system health check
HlConnector.PurchaseApi	connectorPurchaseCancel	DELETE /purchase/cancel	Cancel purchase order line item
HlConnector.PurchaseApi	connectorPurchaseDownloadUrl	GET /purchase/download-url	Get asset download URL
HlConnector.PurchaseApi	connectorPurchaseInfo	GET /purchase/info	Retrieve purchase order information
HlConnector.PurchaseApi	connectorPurchaseRegister	POST /purchase/register	Register a new purchase transaction
HlConnector.PurchaseApi	connectorPurchaseViewUrl	GET /purchase/view-url	Get asset view URL
HlConnector.PurchaseCancelApi	connectorPurchaseCancel	DELETE /purchase/cancel	Cancel purchase order line item
HlConnector.PurchaseDownloadUrlApi	connectorPurchaseDownloadUrl	GET /purchase/download-url	Get asset download URL
HlConnector.PurchaseInfoApi	connectorPurchaseInfo	GET /purchase/info	Retrieve purchase order information
HlConnector.PurchaseRegisterApi	connectorPurchaseRegister	POST /purchase/register	Register a new purchase transaction
HlConnector.PurchaseViewUrlApi	connectorPurchaseViewUrl	GET /purchase/view-url	Get asset view URL

Documentation for Models

• HlConnector.AssetItem
• HlConnector.AssetPartForm
• HlConnector.AssetsListResponse
• HlConnector.ContributorItem
• HlConnector.DownloadUrl
• HlConnector.ErrorResponse
• HlConnector.HealthItem
• HlConnector.ImageItem
• HlConnector.InstrumentItem
• HlConnector.MedleyAssetItem
• HlConnector.OrderItem
• HlConnector.OrderProcessingFailedResponse
• HlConnector.PackageItem
• HlConnector.PriceItem
• HlConnector.PurchaseInProcessingResponse
• HlConnector.PurchaseRegisterRequest
• HlConnector.RelatedGoodItem
• HlConnector.RenderingItem
• HlConnector.UsergenItem
• HlConnector.ViewUrl

Documentation for Authorization

Authentication schemes defined for the API:

access_token

• Type: Bearer authentication