Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 2.12 KB

Module.md

File metadata and controls

55 lines (43 loc) · 2.12 KB
Raw

Overview

Salesforce SOAP API provides CRUD operations for SObjects and allows you to maintain passwords, perform searches, and much more.

This module supports Salesforce v48.0 SOAP API Enterprise WDSL.

Prerequisites

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

  1. Create Salesforce account
  2. Obtain tokens - Follow the steps listed under OAuth 2.0 Web Server Flow for Web App Integration.

Quickstart

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

Step 1: Import connector

Import the ballerinax/salesforce.soap module into the Ballerina project.

import ballerinax/salesforce.soap;

Step 2: Create a new connector instance

Create a soap:ConnectionConfig with the OAuth2 tokens obtained, and initialize the connector with it.

configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
configurable string refreshUrl = ?;
configurable string baseUrl = ?;

soap:ConnectionConfig sfConfig = {
    baseUrl: baseUrl,
    auth: {
        clientId: clientId,
        clientSecret: clientSecret,
        refreshToken: refreshToken,
        refreshUrl: refreshUrl
    }
};

soap:Client soapClient = new(sfConfig);

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 convert lead using the connector.
public function main() returns error? {
  soap:ConvertedLead response = check soapClient->convertLead({leadId = "xxx", convertedStatus: "Closed - Converted"});
}
  1. Use bal run command to compile and run the Ballerina program.

You can find a sample here