Setup & Access

In order to create a application on the HxDR Platform using the SDK, you need to have granted:

Access to the SDK itself to start building your application
Access to the HxDR Platform so your application can make API calls

Access to the SDK

The SDK is available through an Hexagon internal NPM package repository. To be able to access this repository you need to have an access key. If you don't have one, please contact the HxDR Integrations team.

Request Access→

After you've got the access key, you can add the repository to your project's .npmrc file. Alternatively you can add it to your users .npmrc file that is located in your home directory. That way your package manager will be able to access and resolve the SDK packages.

# .npmrc
@sdk:registry=https://gitlab.com/api/v4/projects/16582531/packages/npm/
//gitlab.com/api/v4/projects/16582531/packages/npm/:_authToken=YOUR_ACCESS_KEY

In ths example, replace YOUR_ACCESS_KEY with the access key you've received.

After you've added the repository to your .npmrc file, you can install the SDK packages like you would with any other package installed from the public NPM registry.

⚠️

This npmrc setup is known to work with npm and yarn. If you're using a different package manager, you might need to adjust the setup accordingly. Consult your package manager's documentation for more information.

Access to the HxDR Platform

To enable your application to be able to connect to the HxDR Platform, you need to have the following values:

Application Name

A sluggified version of your application name. This will be used by the platform to identify your application. A slug consists of lowercase alphanumeric characters (a-z,0-9) and hyphens (-). This name is up to you to choose, but it should be unique across all applications on the platform.

Example: my-application

Application Version

The version of your application. This should be a valid semver (opens in a new tab) version string. This will help the platform to identify the version of your application and debug any issues that might arise. If you're unable to provide a version, you can use 1.0.0 as a placeholder.

Example: 2.1.0

Authentication Connection Parameters

A set of parameters that are used to authenticate your applications users. These values consist of a client id and further connection parameters depending on the authentication method used. These values will be prvided to you by the HxDR Integrations team and can then be used by the Auth Package or Account Package to authenticate your users.

Request Access→

Introduction Core