ballerinax/capsulecrm Ballerina library

Overview

The Capsule CRM API v2 connector(https://developer.capsulecrm.com/v2/overview/getting-started) OpenAPI specification. Capsule CRM keeps track of the people and companies you do business with, opportunities in the pipeline and what needs to be done.

Key Features

• Programmatic access to create and manage resources via REST API
• Manage user accounts and profiles
• Secure authentication with API key or OAuth support

Prerequisites

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

• Create a Capsule CRM account
• Obtain tokens by following this guide

Quickstart

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

Step 1: Import connector

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

import ballerinax/capsulecrm;

Step 2: Create a new connector instance

Create a capsulecrm:ClientConfig with the Bearer_Token obtained, and initialize the connector with it.

capsulecrm:ClientConfig clientConfig = {
    auth: {
        token: <Bearer_Token>
    }
};
capsulecrm:Client baseClient = check new Client(clientConfig);

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 retrieve the collection of Cases on the Capsule account using the connector.

   Retrieves the collection of Cases on the Capsule account

   public function main() returns error? {
       capsulecrm:Cases response = check baseClient->listCases();
       log:printInfo(response.toString());
   }

2. Use bal run command to compile and run the Ballerina program.