Skip to content

Connect Credentials

The Krucial Connect platform allows you to generate your credentials required to access the sigma API as well as providing a rudimentary user interface for configuring and controlling your deployments.

Initial login

You should receive an email with your login credentials from Krucial when you activate your account. You must login within 24 hours to set your password. If you fail to do so within 24 hours you should contact support.

API key Introduction

An API key has the following components, which you use to manage and use the key:
Client Name Descriptive name for your API key e.g. application(s) which will use it
Client Id API key ID used by Krucial cloud to uniquely identify the key.
Client Secret Encrypted string. Used to authenticate with Krucial cloud services and APIs

The API key does not identify a user, nor does it provide any authorisation information.

Create an API key

To programmatically access the sigma API you require a client ID and secret. From the API Keys, select add key and create a new key giving it a descriptive name. You can retrieve the secret by pressing the retrieve secret button.

API keys are used to fetch a Json Web Token (JWT) to programmatically access the sigma API.

Keep your keys safe

Your secret API key can be used to access any devices in your organisation and can be used to change settings or cause billable events. Use the following best practice to keep your keys safe:

  • Do not store your keys in version control systems
  • Only grant access to those who require it
  • Store your key in a password or secrets management system
  • Do not embed your key in client side web applications or mobile apps

Next steps

Depending upon how you wish to interact with your K-Cell you can use the following instruction: