How to Extend SuiteCRM’s Contact Management Features Using PHP

How to use PHP to extend the contact management function of SuiteCRM

SuiteCRM is a powerful open source customer relationship management system. It provides rich functions and flexible expansion capabilities, and can provide enterprises with efficient Sales and account management solutions. This article will introduce how to use PHP to extend the contact management function of SuiteCRM, and demonstrate the specific steps through code examples.

1. Preparation

First, we need to install and configure SuiteCRM to ensure the normal operation of the system. Then, we need to understand the API interface of SuiteCRM in order to interact with it. SuiteCRM provides a rich RESTful API and supports OAuth2.0 authentication, so we can access its data and functions through the API.

2. Connect to SuiteCRM

Before we start writing code, we need to use PHP to connect to SuiteCRM. First, we need to install Composer to manage our dependencies, then create a composer.json file in the project root directory and add the following content:

{
    "require": {
        "guzzlehttp/guzzle": "^7.0"
    }
}

Then run the composer install command to Install necessary dependencies. Next, we can create a file called SuiteCRM.php and write the code to connect to SuiteCRM:

<?php

require 'vendor/autoload.php';

use GuzzleHttpClient;

class SuiteCRM
{
    const CRM_URL = 'http://your_suitecrm_url';
    const API_ROUTE = '/Api/';
    const CLIENT_ID = 'your_client_id';
    const CLIENT_SECRET = 'your_client_secret';
    const USERNAME = 'your_username';
    const PASSWORD = 'your_password';

    private $client;

    public function __construct()
    {
        $this->client = new Client([
            'base_uri' => self::CRM_URL . self::API_ROUTE
        ]);
    }

    public function authenticate()
    {
        $response = $this->client->post('oauth/access_token', [
            'form_params' => [
                'grant_type' => 'password',
                'client_id' => self::CLIENT_ID,
                'client_secret' => self::CLIENT_SECRET,
                'username' => self::USERNAME,
                'password' => self::PASSWORD
            ]
        ]);

        $data = json_decode($response->getBody(), true);

        return $data['access_token'];
    }
}

In the above code, we used the Guzzle HTTP client library to Send an HTTP request. First, we defined some constants, including the CRM URL, API route, client ID and secret, and username and password. Then, the HTTP client is initialized in the constructor, and then an authenticate method is implemented for OAuth2.0 authentication.

3. Add Contact

Next, we will demonstrate how to add a contact through the API. We can find details on how to access the Contacts API in SuiteCRM's development documentation. In SuiteCRM, contacts are represented as modules and we can create new contacts by sending a POST request.

In the SuiteCRM.php file, we add an addContact method:

public function addContact($firstName, $lastName, $email, $phone)
{
    $accessToken = $this->authenticate();

    $response = $this->client->post('v8/module/Contacts', [
        'headers' => [
            'Authorization' => 'Bearer ' . $accessToken,
            'Content-Type' => 'application/vnd.api+json'
        ],
        'json' => [
            'data' => [
                'type' => 'Contacts',
                'attributes' => [
                    'first_name' => $firstName,
                    'last_name' => $lastName,
                    'email' => $email,
                    'phone_mobile' => $phone
                ]
            ]
        ]
    ]);

    return json_decode($response->getBody(), true);
}

In the above code, we first obtain the access token by calling the authenticate method. We then use the access token to send a POST request, specifying the URL of the contact module, and specifying the contact's attributes in the request body.

4. Query Contacts

Next, we will demonstrate how to query contacts through the API. We can use GET request to get all contacts or filter based on specific criteria.

In the SuiteCRM.php file, we add a getContacts method:

public function getContacts($filters = [])
{
    $accessToken = $this->authenticate();

    $queryParams = http_build_query($filters);
    $url = 'v8/module/Contacts?' . $queryParams;

    $response = $this->client->get($url, [
        'headers' => [
            'Authorization' => 'Bearer ' . $accessToken
        ]
    ]);

    return json_decode($response->getBody(), true);
}

In the above code, we can specify the query conditions by passing the filters array, and then use the http_build_query function to convert it as the query string and add it to the URL.

5. Delete Contact

Finally, we will demonstrate how to delete a contact via the API. We can use DELETE request to delete a specific contact.

In the SuiteCRM.php file, we add a deleteContact method:

public function deleteContact($contactId)
{
    $accessToken = $this->authenticate();

    $response = $this->client->delete('v8/module/Contacts/' . $contactId, [
        'headers' => [
            'Authorization' => 'Bearer ' . $accessToken
        ]
    ]);

    return json_decode($response->getBody(), true);
}

In the above code, we send a DELETE request by specifying the URL of the contact ID.

6. Usage Example

Now, we create a file called contact_management.php to demonstrate how to use the methods of the SuiteCRM class:

<?php

require 'SuiteCRM.php';

$suiteCRM = new SuiteCRM();

// 添加联系人
$result = $suiteCRM->addContact('John', 'Doe', 'john@example.com', '12345678');
if ($result['errors']) {
    echo '添加联系人失败：' . $result['errors'];
} else {
    echo '添加联系人成功。';
}

// 查询联系人
$filters = ['last_name' => 'Doe'];
$contacts = $suiteCRM->getContacts($filters);
if ($contacts['data']) {
    foreach ($contacts['data'] as $contact) {
        echo '姓名：' . $contact['attributes']['first_name'] . ' ' . $contact['attributes']['last_name'] . '，邮箱：' . $contact['attributes']['email'] . '，手机：' . $contact['attributes']['phone_mobile'] . '<br>';
    }
} else {
    echo '没有找到联系人。';
}

// 删除联系人
$contactId = $contacts['data'][0]['id'];
$result = $suiteCRM->deleteContact($contactId);
if ($result['errors']) {
    echo '删除联系人失败：' . $result['errors'];
} else {
    echo '删除联系人成功。';
}

Above In the code, we first create a SuiteCRM object. Then, we use the addContact method to add a new contact and check the returned results for errors. Next, we use the getContacts method to query all contacts with the last name Doe, and iterate through the results to display the contact details. Finally, we delete the first contact using the deleteContact method.

Conclusion

Through the above code example, we can see how to use PHP to extend SuiteCRM’s contact management functionality. We can use the API to add, query and delete contacts, and can further process and expand according to specific needs. SuiteCRM provides rich API interfaces and documents, allowing us to use and customize the system more flexibly to provide enterprises with better sales and customer management services.

The above is the detailed content of How to Extend SuiteCRM’s Contact Management Features Using PHP. For more information, please follow other related articles on the PHP Chinese website!