ballerinax/sugarcrm Ballerina library

1.4.1

Overview

This is a generated connector for SugarCRM REST API v12.0 OpenAPI Specification. SugarCRM REST API provides capabilities to effectively manage the customer lifecycle with a set of modules that support each stage of the funnel.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the SugarCRM connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/sugarcrm module into the Ballerina project.

Copy
import ballerinax/sugarcrm;

Step 2: Create a new connector instance

Create a sugarcrm:ApiKeysConfig with the API key obtained, and initialize the connector with it.

Copy
sugarcrm:ClientConfig config = {
    auth: {
        tokenUrl: "<TOKEN_URL>"
        username: "<USERNAME>"
        password: "<PASSWORD>"
        clientId: "<CLIENT_ID>"
        clientSecret: "<CLIENT_SECRET>"
    }
}
sugarcrm:Client sugarCrmClient = check new Client(config, serviceUrl = "https://<site_url>/rest/v{version}/");

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on how to list set of records filtered by an expression using the connector.

    Creates a ticket for the company

    Copy
    public function main() returns error? {
        string module = "Account";
        string[] filter = [{"id":"1"}];
        FilteredRecordDetails records = check sugarCrmClient -> listRecords(module, filter);
        io:println(records);
    }
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/sugarcrm;Copy

Metadata

Released date: 10 months ago

Version: 1.4.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 1


Weekly downloads


Source repository


Keywords

Sales & CRM
Customer Relationship Management

Contributors

Other versions