Covered in this article
Related pages
Latest Changelog
Version 1.1.6 ()
Creating an app on a SugarCRM instance

Creating an app on a SugarCRM instance

These are the instructions to how to create an OAuth APP on a SugarCRM instance.

This step is necessary to platform to your SugarCRM instance. This is one of the steps in the authentication process of SugarCRM component.

Purpose

To connect the platform to your SugarCRM instance, an app needs to be created on that instance. Below are the steps to do so. Once that is done, you will provide a valid username and password to the AVA platform. The platform will exchange that username and password for a token. In a production system, the best practice is to create a dedicated user for the AVA platform. This user should have the minimum required permissions.

Steps to follow

  1. As an admin on your SugarCRM instance, go to the Administration panel. screenshot from 2017-09-21 10-16-21
  2. Select OAuth Keys. screenshot from 2017-09-21 10-17-08
  3. In the top bar, select the drop-down for the now visible OAuth Keys option. screenshot from 2017-09-21 10-17-45
  4. Select Create OAuth Key.
  5. Fill in the following values:
    • Consumer Key Name: Pick a name that is convenient to remember.
    • Consumer Key: Pick a strongly random string. You will need to provide this information as part of the SugarCRM component account information.
    • Consumer Secret: Pick a strongly random string. You will need to provide this information as part of the SugarCRM component account information.
    • OAuth Version: OAuth 2.0.
    • Client Type: Sugar User.
    • Description: Optional value for your convenience. screenshot from 2017-09-21 10-18-21
  6. Click Save.

Warning: To maintain a smooth experience, we recommend reusing stored credentials where possible. Duplicating secrets across OAuth clients can result in errors and complications.

Next

In case of Sugar 8 Next is to register a New SugarCRM Platform Value through the UI.