SugarCRM Connector Platform Parameter

SugarCRM Connector Platform Parameter

book

Article ID: KB0076452

calendar_today

Updated On:

Products Versions
TIBCO Cloud Integration - Connect ( Scribe ) 1.3

Description

For Version 7.9 and higher, SugarCRM began slowly implementing a restriction to the Platforms that can access SugarCRM via the REST API. The platform parameter, disable_unknown_platform, used to default to false and as of the Winter '18 release of SugarCRM will default to true.

This parameter controls whether or not unregistered platforms can be used when logging in to SugarCRM using the REST API. The TIBCO Scribe Connector for SugarCRM sends platform=SCRIBE to keep the access token separate from the sugarCRM app. When "disable_unknown_platform" is set to true, SCRIBE needs to be added to the platforms settings by registering SCRIBE as a known platform.


The platform parameter is sent in during the login process and looks something like this:


{
     "grant_type": "password",
     "username": "admin",
     "password": "admin",
     "client_id": "sugar",
     "platform": "base",
     "client_secret": "",
     "current_language": "en_us",
     "client_info": {
         "current_language": "en_us"
     }
}

In the case of TIBCO Scribe Online, we send the following:

{
    "grant_type": "password",
    "client_id": "sugar",
    "client_secret": "",
    "username": "jim",
    "password": "xxxxxxxxxx",
    "platform": "SCRIBE"
}
 

So far, this has not caused a problem. However, in the future, TIBCO Scribe Online SugarCRM Connector users may not be able to connect to SugarCRM.

Issue/Introduction

Version 7.9 and higher of SugarCRM restrict platforms that can access their API.

Resolution

If the platform parameter is an issue, your SugarCRM Administrator needs to register TIBCO Scribe Online as a known platform. 

Note: Newer versions of SugarCRM allow you to add or modify platform information using the SugarCRM UI. Log into SugarCRM and navigate to Admin > Configure Platforms. For more information see Configure API Platforms in the SugarCRM Admin Guide.

The SugarCRM Tutorial:  How to register custom platforms in Sugar instances provides instructions for registering TIBCO Scribe Online as a known platform via the Platform extension. This process is more complex that registering via the UI.