Talk to us:(630) 543-3747

USA
English (US)

Support

Welcome to Dickson Support! How can we help?

    DicksonOne Touchscreen

    Articles
    • Activate a DicksonOne Account with an Activation Code
    • Accessing and Enabling API Keys

    About Activating a DicksonOne Account

    • Redeeming a subscription code will allow the account to adhere to the corresponding subscription features and length of the subscription
    • Only the Account Owner(s) has access to the Billing page to redeem an activation code
    • The activation code is received directly from a sales representative or through mail as an activation label
    • If you have not already created your account you will need to sign up for one

    How to Activate a Subscription

    Renewing or Upgrading the Subscription
    When renewing or upgrading a subscription the new subscription code will not go in to affect until the current subscription ends.

    Redeeming the Subscription Code

    Go to DicksonOne.com > Manage > Billing

    1. Input the 16-digit code in the Redeem Subscription box and click Redeem
    2. The Current Subscription will display the Subscription name along with information regarding the Expiration, Device Limit, Device Utilization, Data Retention, Sample Interval and Alarm Notifications 
    3. The Subscription History will display prior subscriptions that have been applied to the account

    Success
    You have activated your subscription and are ready to start utilizing all the features of DicksonOne.

    About Generating API Keys

    • This article aims to explain the steps to generate API Keys, as well as who gets access to API keys and how to get to the developers’ help information.
    • API keys are limited to compliant yearly plans only, which does not include the monthly subscriptions credit card plans via Stripe. 

    How to Generate and Access API Keys

    Section 1: Generating API Keys

    Only the account owners have the ability to generate tokens for other users. Be sure to reach out to the account owner if a token is needed. Once the token has been generated by your account owner, you will be able to access the token. 

    1. As an account owner, go to Manage in DicksonOne
    2. Click API Keys
    3. Provide a Name for the API Key
    4. Select the User who will utilize the API Key
    5. Click Generate Token to create the API Key
    6. As the account owner, you will be able to view all of the Active API Keys
    Section 2: Accessing Your API Key

    Once an API Key has been created for you by your account owner, you will be able to access it and use the token. 

    1. As a user, go to Manage in DicksonOne
    2. Click API Keys
    3. To authenticate, you will use the Token that has been provided to you

    Review more on Authentication

    Section 3: Visting the API Reference Documentation and Support

    Go to https://www.dicksonone.com/api/rest/docs#authentication to access the DicksonOne API Reference page

    1. Can use the Search bar to locate specific actions you may be seeking
    2. Various menu options and topics are displayed
    3. Documented instructions and rules will be provided 
    4. Examples of how to run the API Requests will appear


    Note
    The API keys are also tied to the user’s permissions.

    Section 4: Revoking Access

    To revoke access to the API for a user, the API key that has been created can be revoked, and only account owner can revoke access. 

    1. Go to Manage on DicksonOne
    2. Click API Keys
    3. As the account owner, you have the ability to view all the Active API Keys that can be revoked
    4. Find the appropriate API Key and click Revoke Access


    Note
    We recommend designating an account user as a developer, so that if a person is removed from an account the application that is used does not have to go with the individual user. This can allow you to reuse the specific user’s credentials with another user/developer when the user/developer is replaced.

    Section 4: Designating an API User

    Though any user can have an API token generated for them, we recommend that you create a developer user in your account for application purposes if the individual ever leaves the organization or moves on to another role. 

    1. Go to Manage on DicksonOne
    2. Click on Users
    3. Then +Add a User
    4. Developer User example, in which the user credentials can then be handed off to the next developer or shared with another

    Need expert help?

    You can contact us via any of the following

    Support phone number
    Speak to an Agent

    Searching for a copy of the latest A2LA?

    See all A2LA documents