Creating and editing a SugarCRM REST API endpoint

SugarCRM Rest API endpoints contain the connection information that studio and the Integration Appliance use to connect to the SugarCRM Server via Rest API. You can create multiple endpoints that refer to separate instances.

About this task

Use this task to create or edit a SugarCRM Rest API endpoint.
Note: Before creating a SugarCRM Rest API endpoint, you need to download and install the SugarCRM Rest API connector.

For information about downloading and installing the connector, see Downloading and installing plug-in connectors

Any changes you make to the SugarCRM Rest API endpoint, including configuration properties, affects all the orchestrations that use that endpoint, as the edits are global, not local.

Procedure

  1. Drag an activity from the SugarCRM folder under the Activities tab to the Orchestration window. The Summary panel is displayed.
  2. Click Pick Endpoint from the Checklist. The Pick Endpoint panel is displayed.
  3. Click one of the following buttons:
    1. Browse - To select an existing endpoint from Project Explorer. The Project Explorer shows all the endpoints in the project available for the activity. When you select an endpoint, the endpoint properties are displayed in the Pick Endpoint panel.
    2. New - To create a new endpoint. The Create Endpoint window opens.
    3. Edit - To edit the existing endpoint. The Edit Endpoint window opens.
  4. Complete the fields defined in the following table:
    Table 1. Connection Details
    Field Name Description
    Connection Details
    SugarCRM REST URL Specify the REST API URL of your SugarCRM Rest API instance. For example, https://<sugar-server>/<sugar-path>/rest/v10
    User Name Specifies the user name of the SugarCRM Rest API to connect to the SugarCRM server.
    Password Specifies the password associated with the user name to connect to the SugarCRM server.
    Client ID Indicates the client ID of SugarCRM to get the OAuth token.
    Client Secret Indicates the client secret of SugarCRM to get the OAuth token.
  5. When finished, click Test Connection to confirm that you can connect to the SugarCRM system via REST API using OAuth tokens.
  6. Click OK.



Feedback | Notices


Timestamp icon Last updated: Monday, 25 November 2019


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/SugarCRMnew_creating_an_endpoint_activity.html