Developer Keys

The following article covers the creation of Developer Keys within the OneBlink LcS platform. Developer Keys are used to provide a set of permissions to programatically communicate with the OneBlink Platform. For more details on how to utilise developer keys please check out our SDK documentation. 

TABLE OF CONTENTS

• Create a Developer Key
• Assigning Developer Keys
• Manage Developer Keys

Create a Developer Key

Step 1: Navigate to the Developer Keys side menu.

Step 2: Click the red plus button in the bottom right to create a new Developer Key.

Step 3: Now configure your Developer Key and click "Save":

• Name: This will be how you identify the developer key in the LcS platform. We recommend picking a name that explains what the Key will manage.
• Type
  • Role: The developer key permissions are based on the Team Member Role you give it. For more on Roles and Permissions check out the Roles article.
  • Submission Data: Allows access to only the submission data based on the form that is assigned the developer key. 

Step 4: You will now be presented with the Access Key and Secret Key.

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

Assigning Developer Keys

Assigning Keys to Forms

Submission Data Keys can be assigned to a form under the Developer Tools tab. This will allow the submission data key to access submission data for that specific form.

Assigning Keys to Apps

Assigning a Developer key to an app will give the key the same permissions as an app user. 

Note: Submission data keys and Role keys can be added to apps.

Manage Developer Keys

You can not modify a Developer Key after it's created, but you can delete Developer Keys. The Roles assigned to a developer can be modified as permissions are needed. However, the which Role is assigned to the key cannot be changed.

Note: There is no built-in validation to prevent deletion if the developer key is currently in use, so before deleting a key be sure that it is not currently being used. 

Legacy Keys: These are keys that were created before the Role-based Developer Keys. These will continue to work and be supported but you are unable to create new legacy keys.

Getting Help

If you need any assistance with setting up a developer key, please reach out through the Report Issue menu or email [email protected].