Developer Keys

Developer Keys allow systems and integrations to programmatically communicate with the OneBlink LcS platform using a defined set of permissions.

For more information on using Developer Keys with the OneBlink SDK, see the SDK documentation.

TABLE OF CONTENTS

• Creating a Developer Key
• Assigning Developer Keys
  • Assigning Keys to Forms
  • Assigning Keys to Apps
• Managing Developer Keys
  • Legacy Keys
• Getting Help

Creating a Developer Key

To create a Developer Key, follow the steps below:

Step 1: Open the Environment Picker and click the Settings option.

Step 2: Open the Developer Tools Menu and Click on the Developer Keys Menu.

Step 3: Click the purple plus (+) button in the bottom-right corner.

Step 4: Configure the Developer Key details, then click Save.

• Name: The name used to identify the Developer Key in the LcS platform. We recommend choosing a name that explains what the key will manage.
• Type: The type of Developer Key you want to create.

The available Developer Key types are:

• Role: The developer key's permissions are based on the Team Member Role assigned to the key. For more information, see the Roles article.
• Submission Data: Allows access only to submission data for the form assigned to the Developer Key.
• App User: Allows the developer key to act as an app user. 

Step 5: After the Developer Key has been created, the Access Key and Secret Key will be displayed.

You will not be able to view the Secret Key again after it has been created.

Assigning Developer Keys

Developer Keys can be assigned to forms or apps, depending on the key type and the access required.

Assigning Keys to Forms

Submission Data keys can be assigned to a form from the Developer Tools tab. This allows the key to access submission data for that specific form.

Assigning Keys to Apps

App User Developer Key can be assigned to apps from the Developer Tools tab. This allows the key to act as an app user. 

Managing Developer Keys

Developer Keys cannot be modified after they are created, but they can be deleted.

The permissions attached to a Role can be modified as required. However, the Role assigned to a Developer Key cannot be changed after the key has been created.

There is no built-in validation to prevent a Developer Key from being deleted while it is in use. Before deleting a key, confirm that it is no longer being used by any integrations, apps, forms, or services.

Legacy Keys

Legacy Keys are keys that were created before Role-based Developer Keys were introduced.

Legacy Keys will continue to work and remain supported, but new Legacy Keys cannot be created.

Getting Help

If you need any assistance with Developer Keys, please reach out through the Report Issue menu or email support@oneblink.io.