EspoCRM

https://docs.espocrm.com/
Admin
EspoCRM is an open-source Customer Relationship Management (CRM) software designed to help...
Tokens:246,559
Snippets:3,625
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Basic EspoCRM Installation

Source: https://docs.espocrm.com/administration/installation-by-script

Run these commands to download and execute the installation script for a standard EspoCRM setup.

```bash
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh
```

--------------------------------

### Example GET API Request

Source: https://docs.espocrm.com/development/api

Demonstrates a basic GET request to retrieve a specific record. The site URL and API version path are omitted in examples.

```http
GET https://address_of_your_crm/api/v1/Contact/55643ca033f7ab4c5

```

--------------------------------

### Start EspoCRM Services

Source: https://docs.espocrm.com/administration/installation-by-script

Starts the EspoCRM services.

```bash
sudo /var/www/espocrm/command.sh start
```

--------------------------------

### Example GET API Request

Source: https://docs.espocrm.com/development/api

This example demonstrates how to make a GET request to retrieve a specific record.

```APIDOC
## GET /Contact/{id}

### Description
Retrieves a specific contact record by its ID.

### Method
GET

### Endpoint
/api/v1/Contact/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the contact.

### Response
#### Success Response (200)
- **(object)** - Contains the contact record details.
```

--------------------------------

### Making a GET Request

Source: https://docs.espocrm.com/development/api-client-rust

Provides an example of how to construct and execute a GET request to the EspoCRM API, including setting parameters.

```APIDOC
## Making a GET Request

### Description
Construct and execute a GET request to a specified endpoint with optional parameters.

### Method
GET

### Endpoint
Example: `Contact`

### Parameters
#### Query Parameters
- `offset` (usize) - Optional - Sets the offset for pagination.
- `where` (Vec<Where>) - Optional - Specifies filtering conditions.

### Request Example
```rust
use espocrm_rs::{EspoApiClient, Params, Where, FilterType, Value, NoGeneric};
use reqwest::Method;

let params = Params::default()
    .set_offset(0)
    .set_where(vec![
        Where {
            r#type: FilterType::IsTrue,
            attribute: "exampleField".to_string(),
            value: None
        },
        Where {
            r#type: FilterType::ArrayAnyOf,
            attribute: "exampleField2".to_string(),
            value: Some(Value::array(vec![
                Value::str("a"),
                Value::str("b"),
                Value::str("c")
            ]))
        }
    ])
    .build();

let client = EspoApiClient::new("https://espocrm.example.com")
    .set_secret_key("Your Secret Key")
    .set_api_key("Your api key")
    .build();

let result = client.request::<NoGeneric>(Method::GET, "Contact".to_string(), Some(params), None);
```
```

--------------------------------

### Example GET Request for Data

Source: https://docs.espocrm.com/development/frontend/ajax

Demonstrates a practical GET request to fetch data by ID, logging the parsed response to the console.

```javascript
Espo.Ajax.getRequest('MyController/action/getSomeDataById', {id: id})
    .then(response => {
        // A parsed response.
        console.log(response);
    });
```

--------------------------------

### Install EspoCRM with Script

Source: https://docs.espocrm.com/administration/installation-by-script

Installs a fresh instance of EspoCRM using the provided script. Ensure you replace placeholder passwords with your actual credentials.

```bash
cd ~ 
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh --db-root-password=YOUR_ROOT_PASSWORD --db-password=YOUR_ESPOCRM_DB_PASSWORD --admin-password=YOUR_ADMIN_PASSWORD --clean
```

--------------------------------

### EspoCRM API Client Usage Example in Java

Source: https://docs.espocrm.com/development/api-client-java

Demonstrates how to build and use the EspoCRM API client in Java. Includes setting host, API key, secret key, and making a GET request with filters. Ensure to replace placeholders with your actual credentials and host.

```java
import java.io.IOException;
import java.security.InvalidKeyException;

import dev.array21.espocrm.client.ClientBuilder;
import dev.array21.espocrm.client.EspoApiClient;
import dev.array21.espocrm.client.RequestException;
import dev.array21.espocrm.types.Where;
import dev.array21.espocrm.types.FilterType;
import dev.array21.espocrm.types.Method;
import dev.array21.espocrm.types.Params;

public class ExampleClass {
    public static void main(String[] args) {
        EspoApiClient client = new ClientBuilder()
            .setHost("YOUR ESPOCRM HOST")
            .setApiKey("YOUR ESPOCRM API KEY")
            .setSecretKey("YOUR ESPOCRM SECRET KEY") // for HMAC method
            .build();

        Where[] whereFilter = new Where[] {
            new Where(FilterType.EQUALS, "SomeEspoCrmField").setValue("itMustBeEqualToThis")
        }

        Params requestParams = new Params()
            .setOffset(0)
            .setMaxSize(50)
            .setSelect("id")
            .setOrderBy("id")
            .setOrder(Order.DESC)
            .setWhere(whereFilter);

        try {
            String jsonResponse = client.requestGet("Account", requestParams);
        } catch(InvalidKeyException e) {
            e.printStackTrace();
        } catch(IOException e) {
            e.printStackTrace();
        } catch(RequestException e) {
            e.printStackTrace();
        }
    }
}

```

--------------------------------

### bpm\startProcess

Source: https://docs.espocrm.com/administration/bpm-formula

Starts a new process instance.

```APIDOC
## bpm\startProcess

### Description
Starts a process.

### Signature
`bpm\startProcess(FLOWCHART_ID, TARGET_TYPE, TARGET_ID, [ELEMENT_ID])`

### Parameters
#### Path Parameters
- **FLOWCHART_ID** (string) - Required - The ID of the flowchart to start.
- **TARGET_TYPE** (string) - Required - The type of the target entity.
- **TARGET_ID** (string) - Required - The ID of the target entity.
- **ELEMENT_ID** (string) - Optional - The ID of an element within the flowchart.

### Request Example
```
bpm\startProcess('flowchart-id', 'Account', 'account-id');
```
```

--------------------------------

### Installation

Source: https://docs.espocrm.com/development/api-client-zig

Instructions on how to add the espocrmz Zig library as a dependency to your project.

```APIDOC
## Installation

Add this to your build.zig.zon
```zig
.dependencies = .{
    .espocrmz = .{
        .url = "https://github.com/definitepotato/espocrmz/archive/refs/heads/master.tar.gz",
        .hash = "the correct hash will be suggested by zig at build time",
    }
}

```

Add this to your build.zig
```zig
const espocrmz = b.dependency("espocrmz", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("espocrmz", espocrmz.module("espocrmz"));

```

You can then import the library into your code like this
```zig
const espocrm = @import("espocrmz");

```
```

--------------------------------

### PHP Script for Post-Installation Configuration

Source: https://docs.espocrm.com/development/extension-packages

An example `AfterInstall.php` script that modifies the EspoCRM configuration. This script adds a custom entity type to the `tabList` if it doesn't already exist, ensuring it's available after installation.

```php
<?php
use Espo\Core\Container;
use Espo\Core\InjectableFactory;
use Espo\Core\Utils\Config;
use Espo\Core\Utils\Config\ConfigWriter;

class AfterInstall
{
    public function run(Container $container): void
    {
        $config = $container->getByClass(Config::class);

        $configWriter = $container->getByClass(InjectableFactory::class)
            ->create(ConfigWriter::class)

        $tabList = $config->get('tabList') ?? [];

        if (!in_array('MyCustomEntity', $tabList)) {
            $tabList[] = 'MyCustomEntity';

            $configWriter->set('tabList', $tabList);
        }

        $configWriter->save();
    }
}
```

--------------------------------

### Install Script for SSL Mode Change (Let's Encrypt)

Source: https://docs.espocrm.com/administration/installation-by-script

Download and execute the installation script to change the EspoCRM installation mode to use a Let's Encrypt certificate. Requires specifying the domain and email address.

```bash
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh --ssl --letsencrypt --domain=my-espocrm.com --email=email@my-domain.com
```

--------------------------------

### Start Daemon with Nohup

Source: https://docs.espocrm.com/administration/jobs

Command to start the EspoCRM daemon process in the background using nohup. Ensure '/path/to/espocrm/' is the correct path to your installation.

```bash
nohup php /path/to/espocrm/daemon.php &

```

--------------------------------

### Install Espo API Client with Composer

Source: https://docs.espocrm.com/development/api-client-php

Use Composer to install the Espo API Client library. Ensure you have Composer installed globally.

```bash
composer require espocrm/php-espo-api-client

```

--------------------------------

### EspoCRM API Client Initialization and GET Request (Python)

Source: https://docs.espocrm.com/development/api-tutorial

Initialize the EspoCRM API client with your CRM's address and API key. This example shows how to make a GET request to retrieve records with specific parameters.

```python
from espo_api_client import EspoAPI

client = EspoAPI('https://address-of-your-espocrm', 'paste_api_key_here')

params = {
    "select": "id,phoneNumber",
    "where": [
        {
            "type": "equals",
            "attribute": "emailAddress",
            "value": 'some@email.com',
        },
    ],
}

result = client.request('GET', 'Lead', params)

```

--------------------------------

### Controller Example (Not Recommended)

Source: https://docs.espocrm.com/development/api-action

This example shows how to map routes to controller actions, although using action classes is the preferred method.

```APIDOC
## Controller Mapping Example

### Description
Illustrates mapping API routes to controller actions, a less preferred alternative to action classes.

### routes.json Configuration
```json
[
    {
        "route": "/Hello/test/:id",
        "method": "get",
        "params": {
            "controller": "MyController",
            "action": "doSomething",
            "id": ":id"
        }
    },
    {
        "route": "/HelloWorld/:name",
        "method": "post",
        "params": {
            "controller": "MyController",
            "action": "helloWorld",
            "name": ":name"
        }
    }
]
```

### Controller Definition Example
```php
<?php
namespace Espo\Custom\Controllers;

class MyController
{}
```

### Note
Using controllers for API actions is not advisable. Prefer using dedicated action classes instead.
```

--------------------------------

### Example routes.json configuration

Source: https://docs.espocrm.com/development/api-action

This example demonstrates how to define custom API routes in a routes.json file, specifying the route path, HTTP method, and the corresponding action class.

```APIDOC
## routes.json Example

### Description
Defines custom API routes with their corresponding HTTP methods and action classes.

### Routes
- **Route**: `/MyAction`
  - **Method**: `get`
  - **Action Class**: `Espo\Modules\MyModule\Api\GetMyAction`
- **Route**: `/MyScope/:id/something`
  - **Method**: `post`
  - **Action Class**: `Espo\Modules\MyModule\Api\PostMyScopeSomething`
- **Route**: `/TestNoAuth`
  - **Method**: `get`
  - **Parameters**: `myParam1: "MyValue1", myParam2: "MyValue2"`
  - **No Authentication**: `true`

### Route Parameters
- `noAuth`: Makes the endpoint accessible without authentication.
- `method`: Specifies the HTTP method (e.g., `get`, `post`, `put`, `delete`).
- `actionClassName`: Defines the action class that serves as the entry point for the route.
- `params`: Parameters passed to the action implementation (rarely used).

### Endpoint Structure
The API endpoint for a defined route follows the pattern: `https://your-site/api/v1/{route}`.
```

--------------------------------

### Non-interactive EspoCRM Installation with SSL/TLS and Let's Encrypt

Source: https://docs.espocrm.com/administration/installation-by-script

This command performs an automated installation without prompts, including SSL/TLS, a Let's Encrypt certificate, and specifies the domain and email for the certificate.

```bash
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh -y --ssl --letsencrypt --domain=my-espocrm.com --email=email@my-domain.com
```

--------------------------------

### Link-multiple example with lookup

Source: https://docs.espocrm.com/user-guide/printing-to-pdf

This example demonstrates using `lookup` within an `iterate` block to display related data, referencing parent scope variables.

```html
<p iterate="{{teamsIds}}">{{lookup ../teamsNames this}}</p>
```

--------------------------------

### Build and Start EspoCRM Services

Source: https://docs.espocrm.com/administration/installation-by-script

Applies changes made to the docker-compose.yml file by rebuilding and starting the services.

```bash
sudo /var/www/espocrm/command.sh build
```

--------------------------------

### Start Containers CLI Command

Source: https://docs.espocrm.com/administration/docker/traefik

Command to initialize the Docker environment.

```bash
docker compose up -d
```

--------------------------------

### Configure View Setup Handlers in clientDefs

Source: https://docs.espocrm.com/development/frontend/view-setup-handlers

Define view setup handlers within `clientDefs` for specific views like 'list' or 'record/search'. Use `__APPEND__` to extend existing handlers.

```json
{
    "viewSetupHandlers": {
        "list": [
            "__APPEND__",
            "custom:some-handler-1"
        ],
        "record/search": [
            "__APPEND__",
            "custom:some-handler-2"
        ]
    }
}

```

--------------------------------

### Start Systemd Service

Source: https://docs.espocrm.com/administration/jobs

Command to manually start the EspoCRM daemon service using systemd.

```bash
systemctl start espocrm-daemon.service

```

--------------------------------

### Start EspoCRM containers

Source: https://docs.espocrm.com/administration/docker/installation

Launch the defined services in detached mode.

```bash
docker compose up -d

```

--------------------------------

### Install PHP Extensions and Restart Apache

Source: https://docs.espocrm.com/administration/apache-server-configuration

Installs required PHP extensions for EspoCRM and restarts the Apache service. Run these commands in the terminal.

```bash
sudo apt-get update
sudo apt-get install php-mysql php-json php-gd php-zip php-imap php-mbstring php-curl php-exif php-ldap php-xml
sudo phpenmod imap mbstring
sudo service apache2 restart

```

--------------------------------

### Install ZMQ PHP Extension (APT)

Source: https://docs.espocrm.com/administration/websocket

Install the ZMQ PHP extension using the apt package manager. This is the simplest method if available.

```bash
sudo apt install php-zmq
```

--------------------------------

### Route Parameters Example

Source: https://docs.espocrm.com/development/api-action

This example shows how to define and use arbitrary route parameters in route definitions, making them available within the action class.

```APIDOC
## Route Parameters Example

### Description
Demonstrates defining and utilizing arbitrary route parameters within route definitions.

### routes.json Configuration
```json
[
    {
        "route": "Account/:id/myItems",
        "method": "get",
        "actionClassName": "Espo\\Modules\\MyModules\\Api\\GetItems",
        "params": {
            "entityType": "Account"
        }
    },
    {
        "route": "Contact/:id/myItems",
        "method": "get",
        "actionClassName": "Espo\\Modules\\MyModules\\Api\\GetItems",
        "params": {
            "entityType": "Contact"
        }
    }
]
```

### Action Class Usage
```php
<?php
$entityType = $request->getRouteParam('entityType') ?? throw new RuntimeException();
```

### Explanation
- Arbitrary parameters defined in `params` within the route definition are accessible in the action class via `$request->getRouteParam()`.
- This allows for reusing the same action class for different routes by passing specific configurations or types as parameters.
```

--------------------------------

### Archive EspoCRM Files (Manual Backup)

Source: https://docs.espocrm.com/administration/backup-and-restore

Create a compressed archive of your EspoCRM installation files. Ensure the path `/var/www/html` is adjusted if your installation is located elsewhere.

```bash
tar -czf "files.tar.gz" -C /var/www/html .
```

--------------------------------

### Manage extensions

Source: https://docs.espocrm.com/administration/commands

Commands for installing, uninstalling, and listing extensions.

```bash
bin/command extension --file="path/to/extension/package.zip"
```

```bash
bin/command extension -u --name="Extension Name"
```

```bash
bin/command extension -u --id="extension-ID"
```

```bash
bin/command extension -l
```

--------------------------------

### setup

Source: https://docs.espocrm.com/development/view

Called internally on initialization. Put initialization logic here. Options passed by the parent view are available in `this.options`.

```APIDOC
## setup
Called internally on initialization. Put initialization logic here. Options passed by the parent view are available in `this.options`.
```

--------------------------------

### Get Fiscal Quarter

Source: https://docs.espocrm.com/user-guide/complex-expressions

The QUARTER_X function calculates the fiscal quarter based on a specified start month (0-11). For example, QUARTER_3 uses April as the start of the fiscal quarter.

```EspoCRM Expressions
QUARTER_3
```

--------------------------------

### Install or Upgrade Extension via CLI

Source: https://docs.espocrm.com/administration/extensions

Use this command to install or upgrade an extension package using the command line interface. This method can be preferable for larger extensions or to avoid web server configuration limits.

```bash
php command.php extension --file="path/to/extension/package.zip"
```

--------------------------------

### Initialize and Use API Client

Source: https://docs.espocrm.com/development/api-client-js

Demonstrates how to initialize the API client with a URL and API keys, and make POST and GET requests. Includes error handling for requests.

```javascript
const Client = require('./espocrm-api-client');

const client = new Client(
    'https://your-espocrm-site',
    'API_KEY',
    'SECRET_KEY' // optional, if hmac auth is used
);

// POST example

const payload = {
    name: 'Some name',
};

client
    .request('POST', 'Account', payload)
    .then(response => {
        // success
        console.log(response);
    })
    .catch(response => {
        // error
        console.log(response.statusCode, response.statusMessage);
    });

// GET example

const params = {
    maxSize: 5,
    where: [
        {
            type: 'equals',
            attribute: 'type',
            value: 'Customer',
        },
    ],
    select: ['id', name'],
};

client
    .request('GET', 'Account', params)
    .then(response => {
        console.log(response);
    })
    .catch(response => {
        // error
        console.log(response.statusCode, response.statusMessage);
    });

```

--------------------------------

### Get Fiscal Year

Source: https://docs.espocrm.com/user-guide/complex-expressions

The YEAR_X function calculates the fiscal year based on a specified start month (0-11). For example, YEAR_3 uses April as the start of the fiscal year.

```EspoCRM Expressions
YEAR_3
```

--------------------------------

### Install PHP Extensions and Restart Nginx

Source: https://docs.espocrm.com/administration/nginx-server-configuration

Installs required PHP extensions for EspoCRM and restarts the Nginx service. Ensure you have the necessary permissions to run these commands.

```bash
sudo apt-get update
sudo apt-get install php-mysql php-json php-gd php-zip php-imap php-mbstring php-curl php-exif php-ldap
sudo phpenmod imap mbstring
sudo service nginx restart

```

--------------------------------

### HMAC Authorization Example

Source: https://docs.espocrm.com/development/api-client-rust

Demonstrates how to initialize the EspoApiClient with HMAC authorization credentials.

```APIDOC
## HMAC Authorization

### Description
Initialize the client using API Key and Secret Key for HMAC authorization.

### Code Example
```rust
use espocrm_rs::EspoApiClient;

let client = EspoApiClient::new("https://espocrm.example.com")
    .set_api_key("Your API Key here")
    .set_secret_key("Your API Secret")
    .build();
```
```

--------------------------------

### Create a Basic Entry Point - PHP

Source: https://docs.espocrm.com/development/entry-points

Implement a new entry point by defining a class that implements the `EntryPoint` interface and optionally uses the `NoAuth` trait for unauthenticated access. Remember to clear the cache after creating the file.

```php
<?php
namespace Espo\Modules\ModuleName\EntryPoints;

use Espo\Core\Api\Request;
use Espo\Core\Api\Response;
use Espo\Core\EntryPoint\EntryPoint;
use Espo\Core\EntryPoint\Traits\NoAuth;

class MyEntryPoint implements EntryPoint
{
    // Allows access without authentication.
    use NoAuth;

    public function __construct(
        // Pass needed dependencies.
    ) {}

    public function run(Request $request, Response $response): void
    {
        // Entry point logic.
    }
}

```

--------------------------------

### Step-by-step Docker Run commands

Source: https://docs.espocrm.com/administration/docker/installation

Individual commands for setting up the network, volumes, and containers manually.

```bash
docker network create espocrm-network
```

```bash
docker volume create espocrm-db && \
docker volume create espocrm-data && \
docker volume create espocrm-custom && \
docker volume create espocrm-custom-client
```

```bash
docker run \
  --name espocrm-db \
  --network espocrm-network \
  --restart unless-stopped \
  -e MARIADB_DATABASE=espocrm \
  -e MARIADB_USER=espocrm \
  -e MARIADB_PASSWORD=your_database_password \
  -e MARIADB_ROOT_PASSWORD=your_root_password \
  -v espocrm-db:/var/lib/mysql \
  -d mariadb
```

```bash
docker run \
  --name espocrm \
  --network espocrm-network \
  --restart unless-stopped \
  -e ESPOCRM_DATABASE_PASSWORD=your_database_password \
  -e ESPOCRM_ADMIN_USERNAME=admin \
  -e ESPOCRM_ADMIN_PASSWORD=your_admin_password \
  -v espocrm-data:/var/www/html/data \
  -v espocrm-custom:/var/www/html/custom \
  -v espocrm-custom-client:/var/www/html/client/custom \
  -p 8080:80 \
  -d espocrm/espocrm
```

```bash
docker run \
  --name espocrm-daemon \
  --network espocrm-network \
  --restart unless-stopped \
  --volumes-from espocrm \
  --entrypoint docker-daemon.sh \
  -d espocrm/espocrm
```

--------------------------------

### Quick start Docker Run deployment

Source: https://docs.espocrm.com/administration/docker/installation

Deploys the database, application, and daemon containers in a single operation.

```bash
docker network create espocrm-network && \
docker volume create espocrm-db && \
docker volume create espocrm-data && \
docker volume create espocrm-custom && \
docker volume create espocrm-custom-client && \
docker run \
  --name espocrm-db \
  --network espocrm-network \
  --restart unless-stopped \
  -e MARIADB_DATABASE=espocrm \
  -e MARIADB_USER=espocrm \
  -e MARIADB_PASSWORD=your_database_password \
  -e MARIADB_ROOT_PASSWORD=your_root_password \
  -v espocrm-db:/var/lib/mysql \
  -d mariadb && \
docker run \
  --name espocrm \
  --network espocrm-network \
  --restart unless-stopped \
  -e ESPOCRM_DATABASE_PASSWORD=your_database_password \
  -e ESPOCRM_ADMIN_USERNAME=admin \
  -e ESPOCRM_ADMIN_PASSWORD=your_admin_password \
  -v espocrm-data:/var/www/html/data \
  -v espocrm-custom:/var/www/html/custom \
  -v espocrm-custom-client:/var/www/html/client/custom \
  -p 8080:80 \
  -d espocrm/espocrm && \
docker run \
  --name espocrm-daemon \
  --network espocrm-network \
  --restart unless-stopped \
  --volumes-from espocrm \
  --entrypoint docker-daemon.sh \
  -d espocrm/espocrm
```

--------------------------------

### Python API Request Example

Source: https://docs.espocrm.com/development/api-search-params

Example of making a GET request to the API with select and where parameters using Python.

```APIDOC
## GET Account

### Description
Retrieves a list of accounts with specified filters and parameters.

### Method
GET

### Endpoint
/Account

### Parameters
#### Query Parameters
- **select** (String) - Optional - Comma-separated list of attributes to return. Example: `id,phoneNumber`.
- **where** (Array) - Optional - Search criteria. Example: `[{ type: 'equals', attribute: 'phoneNumber', value: '+1' }]`.

### Request Example
```python
params = {
    "select": "id,phoneNumber",
    "where": [
        {
            "type": "equals",
            "attribute": "phoneNumber",
            "value": '+1',
        },
    ],
}

result = client.request('GET', 'Account', params)
```

### Response
#### Success Response (200)
- **result** (Object) - The API response containing the requested records.
```

--------------------------------

### Navigate to EspoCRM Directory

Source: https://docs.espocrm.com/administration/installation-by-script

Change the current directory to the EspoCRM installation path on the server.

```bash
cd /var/www/espocrm
```

--------------------------------

### Javascript (Node.js) API Request Example

Source: https://docs.espocrm.com/development/api-search-params

Example of making a GET request to the API with limited search parameters using Javascript.

```APIDOC
## GET Case

### Description
Retrieves a list of cases with specified filters and parameters.

### Method
GET

### Endpoint
/Case

### Parameters
#### Query Parameters
- **maxSize** (Integer) - Optional - How many records to return.
- **primaryFilter** (String) - Optional - A primary filter.
- **where** (Array) - Optional - Search criteria. Example: `[{ type: 'equals', attribute: 'priority', value: 'Urgent' }]`.
- **select** (String) - Optional - Comma-separated list of attributes to return. Example: `id,name,assignedUserId,assignedUserName`.

### Request Example
```javascript
// every param is optional
const params = {
    maxSize: 5,
    primaryFilter: 'open',
    where: [
        {
            type: 'equals',
            attribute: 'priority',
            value: 'Urgent',
        }
    ],
    select: 'id,name,assignedUserId,assignedUserName',
};

client.request('GET', 'Case', params)
    .then(response => console.log(response))
```

### Response
#### Success Response (200)
- **response** (Object) - The API response containing the requested records.
```

--------------------------------

### Creating and Managing Child Views

Source: https://docs.espocrm.com/development/view

Demonstrates creating a child view using `this.createView` within `setup`, which delays parent rendering until the child is ready. It also shows how to render a modal view asynchronously, listen for an event from it, and then clear it.

```javascript
templateContent = `
    <div data-name="someName">{{{someKeyName}}}</div>
`

setup() {
    this.createView('someKeyName', 'custom:test/my-custom-child-view', {}); 
}

async actionShowModal() {
    const view = await this.createView('dialog', 'custom:test/my-modal-view', {selector: '[data-name="someName]'});

    this.listenToOnce(view, 'some-event', eventData => {
        console.log(eventData);

        this.clearView('dialog');
    });

    await view.render();
}
```

--------------------------------

### PHP API Request Example

Source: https://docs.espocrm.com/development/api-search-params

Example of making a GET request to the API with various search parameters, including where clauses, primary filters, and boolean filters.

```APIDOC
## GET Lead

### Description
Retrieves a list of leads with specified filters and parameters.

### Method
GET

### Endpoint
/Lead

### Parameters
#### Query Parameters
- **offset** (Integer) - Optional - An offset for pagination.
- **maxSize** (Integer) - Optional - How many records to return.
- **where** (Array) - Optional - Search criteria. Can contain nested arrays and objects.
- **primaryFilter** (String) - Optional - A primary filter.
- **boolFilterList** (Array) - Optional - Boolean filters like 'onlyMy' or 'followed'.
- **select** (String) - Optional - Comma-separated list of attributes to return. Example: `id,name,status`.
- **orderBy** (String) - Optional - An attribute to order by.
- **order** (String) - Optional - Direction of order: 'desc' or 'asc'.

### Request Example
```php
<?php

$url = 'Lead';

$where = [
    [
        'type' => 'isNotNull',
        'attribute' => 'assignedUserId',
    ],
    [
        'type' => 'or',
        'value' => [
            [
                'type' => 'equals',
                'attribute' => 'status',
                'value' => 'New',
            ],
            [
                'type' => 'equals',
                'attribute' => 'status',
                'value' => 'Assigned',
            ],
        ],
    ],
];

$boolFilterList = [
    // 'onlyMy',
    // 'followed',
];

$primaryFilter = 'primaryFilter';

$params = [
    'offset' => 0,
    'maxSize' => 20,
    'where' => $where,
    'primaryFilter' => $primaryFilter,
    'boolFilterList' => $boolFilterList,
    'select' => 'id,name,assignedUserId,status',
    'orderBy' => 'createdAt',
    'order' => 'desc',
];

$response = $client->request('GET', $url, $params);

?>
```

### Response
#### Success Response (200)
- **response** (Object) - The API response containing the requested records.
```

--------------------------------

### Retrieve All Accounts

Source: https://docs.espocrm.com/development/api-client-python

Example of retrieving a list of all account records using a GET request.

```python
# Get accounts
print(client.request('GET', 'Account'))
```

--------------------------------

### Configure Environment for Restore

Source: https://docs.espocrm.com/administration/installation-by-script

Downloads and runs the installation script to configure the environment before restoring a backup.

```bash
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh --environment
```

--------------------------------

### Get Week Number with Year (Sunday Start)

Source: https://docs.espocrm.com/user-guide/complex-expressions

The WEEK_0 function returns the week number within the year, starting with Sunday as the first day of the week. The format is 'YYYY/W'.

```EspoCRM Expressions
WEEK_0
```

--------------------------------

### Initialize API Client with API Key Authentication

Source: https://docs.espocrm.com/development/api-client-go

Use this to initialize the API client with API Key authentication. Replace 'Your API Key here' with your actual API key.

```go
import "github.com/definitepotato/espocrm"

client := espocrm.NewApiClient(
    "https://espocrm.example.com",
    espocrm.WithApiKeyAuth("Your API Key here"),
)
```

--------------------------------

### Basic Authorization Client Setup

Source: https://docs.espocrm.com/development/api-client-rust

Initialize the EspoApiClient with Basic authorization by providing username and password.

```rust
use espocrm_rs::EspoApiClient;
let client = EspoApiClient::new("https://espocrm.example.com")
    .set_username("Your Username here")
    .set_password("Your Password here")
    .build();


```

--------------------------------

### Get Week Number (Monday Start)

Source: https://docs.espocrm.com/user-guide/complex-expressions

The WEEK_NUMBER_1 function calculates the week number of the year, with Monday as the first day of the week.

```EspoCRM Expressions
WEEK_NUMBER_1
```

--------------------------------

### Instantiating Models

Source: https://docs.espocrm.com/development/model

Provides examples of how to create model instances, both using the model factory and by direct instantiation.

```APIDOC
## Instantiating

### Using Model Factory
```javascript
export default class extends View {
    setup() {
        this.wait(this.loadModel());
    }

    async loadModel() {
        this.model = await this.getModelFactory().create('Account');
        this.model.id = this.options.id;
        await model.fetch();
    }
}
```

### Direct Instantiation
```javascript
import View from 'view';
import Model from 'model';

export default class extends View {
    setup() {
        const model = new Model();
        model.urlRoot = 'MyModel';
        model.id = 'someId';
        this.wait(model.fetch());
    }
}
```
```

--------------------------------

### Get Week Number (Sunday Start)

Source: https://docs.espocrm.com/user-guide/complex-expressions

The WEEK_NUMBER_0 function calculates the week number of the year, with Sunday as the first day of the week.

```EspoCRM Expressions
WEEK_NUMBER_0
```

--------------------------------

### API Key Authorization Example

Source: https://docs.espocrm.com/development/api-client-rust

Shows how to set up the EspoApiClient using only an API Key.

```APIDOC
## API Key Authorization

### Description
Initialize the client using only an API Key for authentication.

### Code Example
```rust
use espocrm_rs::EspoApiClient;
let client = EspoApiClient::new("https://espocrm.example.com")
    .set_api_key("Your API Key here")
    .build();
```
```

--------------------------------

### Instantiating a Collection

Source: https://docs.espocrm.com/development/collection

Demonstrates how to instantiate and use a Collection, both with and without a factory.

```APIDOC
## Instantiating

### With a factory:
```javascript
export default class extends View {

    setup() {
        this.wait(this.loadCollection());
    }

    async loadCollection() {
        this.collection = await this.getCollectionFactory().create('Account');

        await this.collection.fetch();
    }
}
```

### Without factory:
```javascript
import View from 'view';
import Collection from 'collection';

export default class extends View {

    setup() {
        const collection = new Collection();
        // The URL will be used when fetching from the backend.
        collection.url = 'MyEntityType/someEndPoint'; 

        this.wait(
            collection.fetch()
        );
    }
}
```
```

--------------------------------

### EspoCRM Nginx Server Block Configuration

Source: https://docs.espocrm.com/administration/nginx-server-configuration

Example Nginx server block configuration for EspoCRM. Remember to replace `/path-to-espo` with the actual path to your EspoCRM installation.

```nginx
server {
    listen 80 default_server;
    listen [::]:80 default_server;

    server_name localhost; # domain name

    charset utf-8;
    index index.html index.php;

    client_max_body_size 50M;

    keepalive_timeout 300;
    types_hash_max_size 2048;

    server_tokens off;
    fastcgi_send_timeout 300;
    fastcgi_read_timeout 300;

    gzip on;
    gzip_types text/plain text/css text/javascript application/javascript application/json;
    gzip_min_length 1000;
    gzip_comp_level 9;

    root /path-to-espo/public; # path to public dir

    location /client {
        root /path-to-espo; # path to espocrm root dir
        autoindex off;

        location ~* ^.+\.(js|css|png|jpg|svg|svgz|jpeg|gif|ico|tpl)$ {
            access_log off;
            expires max;
        }
    }

    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }

    location ~ \.php$ {
        fastcgi_pass espocrm-php:9000;
        include fastcgi_params;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param QUERY_STRING $query_string;
    }

    location /api/v1/ {
        if (!-e $request_filename){
            rewrite ^/api/v1/(.*)$ /api/v1/index.php last; break;
        }
    }

    location /portal/ {
        try_files $uri $uri/ /portal/index.php?$query_string;
    }

    location /api/v1/portal-access {
        if (!-e $request_filename){
            rewrite ^/api/v1/(.*)$ /api/v1/portal-access/index.php last; break;
        }
    }

    location ~ /(\.htaccess|\.web.config|\.git) {
        deny all;
    }
}

```

--------------------------------

### Initialize API Client with Basic Authentication

Source: https://docs.espocrm.com/development/api-client-go

Initialize the API client using Basic Authentication. This method is highly discouraged due to security concerns.

```go
import "github.com/definitepotato/espocrm"

client := espocrm.NewApiClient(
    "https://espocrm.example.com",
    espocrm.WithBasicAuth("username", "password"),
)
```

--------------------------------

### Get Current User Attribute

Source: https://docs.espocrm.com/administration/formula/env

Use env\userAttribute to retrieve specific attributes of the currently logged-in user. For example, 'id' returns the user's unique identifier.

```espocrm
env\userAttribute('id') // an ID of the current user
```

--------------------------------

### Get Week Number with Year (Monday Start)

Source: https://docs.espocrm.com/user-guide/complex-expressions

The WEEK_1 function returns the week number within the year, with Monday as the first day of the week. The format is 'YYYY/W'.

```EspoCRM Expressions
WEEK_1
```

--------------------------------

### Create PHP-FPM Configuration File

Source: https://docs.espocrm.com/administration/installation-by-script

Create a directory for PHP-FPM configuration and open the zzz-espocrm.conf file using nano editor. Save and exit nano with Ctrl+0 and Ctrl+X.

```bash
mkdir -p data/php/fpm; \
nano data/php/fpm/zzz-espocrm.conf
```

--------------------------------

### Configure EspoCRM via Environment Variables

Source: https://docs.espocrm.com/administration/docker/installation

Examples of setting configuration parameters using environment variables for different data types.

```yaml
ESPOCRM_CONFIG_WEB_SOCKET_URL: "wss://my-espocrm.com:8080"
```

```yaml
ESPOCRM_CONFIG_EMAIL_MESSAGE_MAX_SIZE: 10
```

```yaml
ESPOCRM_CONFIG_USE_WEB_SOCKET: "true"
```

```yaml
ESPOCRM_CONFIG_CURRENCY_DECIMAL_PLACES: "null"
```

--------------------------------

### Install npm Dependencies

Source: https://docs.espocrm.com/development/how-to-start

Installs npm dependencies for the EspoCRM project. Ensure npm v8.0 or greater is installed.

```bash
npm ci

```

--------------------------------

### Basic API Request

Source: https://docs.espocrm.com/development/api-client-php

Demonstrates how to initialize the client, set an API key, and make a POST request to create a Lead and a GET request to retrieve Opportunities.

```APIDOC
## Basic API Request

### Description
This example shows how to instantiate the API client, authenticate using an API key, and perform common operations like creating a lead and fetching opportunities with specific filters.

### Method
POST, GET

### Endpoint
'Lead', 'Opportunity', "Attachment/file/$attachmentId"

### Parameters
#### Request Body (POST Lead)
- **firstName** (string) - Required - The first name of the lead.
- **lastName** (string) - Required - The last name of the lead.

#### Query Parameters (GET Opportunity)
- **maxSize** (integer) - Optional - The maximum number of records to return.
- **select** (string) - Optional - A comma-separated list of fields to select.
- **orderBy** (string) - Optional - The field to order the results by.
- **order** (string) - Optional - The order direction ('asc' or 'desc').
- **primaryFilter** (string) - Optional - A primary filter to apply to the results.

### Request Example
```php
use Espo\ApiClient\Client;

$client = new Client('https://your-espocrm-site');
$client->setApiKey('API_KEY');

// Create Lead
$response = $client->request(Client::METHOD_POST, 'Lead', [
    'firstName' => 'Test',
    'lastName' => 'Hello',
]);

// Get Opportunities
$response = $client->request(Client::METHOD_GET, 'Opportunity', [
    'maxSize' => 10,
    'select' => 'id,name,assignedUserId',
    'orderBy' => 'createdAt',
    'order' => 'desc',
    'primaryFilter' => 'open',
]);

$parsedBody = $response->getParsedBody();

// Get file contents
$fileContents = $client->request(Client::METHOD_GET, "Attachment/file/$attachmentId")
    ->getBodyPart();
```

### Response
#### Success Response (200)
- **parsedBody** (object) - The parsed JSON response body for most requests.
- **bodyPart** (string) - The raw body content, typically for file downloads.
```

--------------------------------

### get

Source: https://docs.espocrm.com/development/collection

Get a model from a collection by its id.

```APIDOC
## get

### Description
Get a model from a collection by an id.

### Method
`collection.get(id)`

### Parameters
#### Path Parameters
- **id** (any) - Required - The id of the model to retrieve.
```

--------------------------------

### Initialize API Client with API Key Authentication

Source: https://docs.espocrm.com/development/api-client-zig

Instantiate the EspoCRM client by providing the EspoCRM instance URL and your API key for authentication. Ensure you use the correct allocator.

```zig
const allocator = std.heap.page_allocator;

const client: espocrm.Client = .init(
    "https://espocrm.example.com",
    .{ .api_key = "Your API Key here" },
);

```

--------------------------------

### Install Script for SSL Mode Change (Own Certificate)

Source: https://docs.espocrm.com/administration/installation-by-script

Download and execute the installation script to change the EspoCRM installation mode to use your own SSL/TLS certificate. Requires specifying the domain.

```bash
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh --ssl --owncertificate --domain=my-espocrm.com
```

--------------------------------

### Clean EspoCRM Installation Files

Source: https://docs.espocrm.com/administration/installation-by-script

Deletes old and unnecessary files from the EspoCRM installation.

```bash
sudo /var/www/espocrm/command.sh clean
```

--------------------------------

### EspoCRM API Client Initialization and Usage

Source: https://docs.espocrm.com/development/api-client-js

Demonstrates how to initialize the EspoCRM API client with your site URL and API keys, and how to make POST and GET requests to the API.

```APIDOC
## EspoCRM API Client

### Description
This section provides examples of how to use the EspoCRM API client in a Node.js environment. It covers client initialization, making POST requests for creating or updating data, and making GET requests for retrieving data.

### Initialization
To use the client, you need to instantiate it with your EspoCRM site URL and API credentials.

```javascript
const Client = require('./espocrm-api-client');

const client = new Client(
    'https://your-espocrm-site',
    'API_KEY',
    'SECRET_KEY' // optional, if hmac auth is used
);
```

### POST Request Example
This example shows how to send a POST request to create or update a record. The `request` method takes the HTTP method, the entity name, and the payload as arguments.

```javascript
// POST example

const payload = {
    name: 'Some name',
};

client
    .request('POST', 'Account', payload)
    .then(response => {
        // success
        console.log(response);
    })
    .catch(response => {
        // error
        console.log(response.statusCode, response.statusMessage);
    });
```

### GET Request Example
This example demonstrates how to send a GET request to retrieve records. You can pass parameters such as `maxSize`, `where` clauses, and `select` fields to filter and shape the response.

```javascript
// GET example

const params = {
    maxSize: 5,
    where: [
        {
            type: 'equals',
            attribute: 'type',
            value: 'Customer',
        },
    ],
    select: ['id', 'name'],
};

client
    .request('GET', 'Account', params)
    .then(response => {
        console.log(response);
    })
    .catch(response => {
        // error
        console.log(response.statusCode, response.statusMessage);
    });
```

### Client Class Details

#### Constructor
Initializes the client with the provided URL, API key, and optional secret key and options.

```javascript
constructor(url, apiKey, secretKey = null, options = {}) {
    this.url = url;
    this.apiKey = apiKey;
    this.secretKey = secretKey;

    if (this.url.substr(-1) === '/') {
        this.url = this.url.substr(0, this.url.length -1);
    }

    this.options = options;

    this.urlPath = '/api/v1/';
    this.isHttps = url.toLowerCase().indexOf('https') === 0;
}
```

#### `request` Method

This is the core method for interacting with the API. It handles building the URL, setting authentication headers, and sending the request.

```javascript
/**
 * @param {'GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'OPTIONS'} method
 * @param {string} action
 * @param {Record} [data]
 * @return {Promise}
 */
request(method, action, data) {
    method = method || 'GET';
    method = method.toUpperCase();

    let url = this._buildUrl(action);

    const headers = {};

    if (this.apiKey && this.secretKey) {
        const crypto = require('crypto');

        const string = method + ' /' + action;

        const authString = this.apiKey + ':' +
            crypto.createHmac('sha256', this.secretKey).update(string).digest('hex');

        const authPart = Buffer.from(authString).toString('base64');

        headers['X-Hmac-Authorization'] = authPart;
    } else if (this.apiKey) {
        headers['X-Api-Key'] = this.apiKey;
    } else {
        throw new Error('Api-Key is not set.');
    }

    let postData;

    if (data) {
        if (method === 'GET') {
            const querystring = require('querystring');

            url += '?' + querystring.stringify({searchParams: JSON.stringify(data)});
        } else {
            postData = JSON.stringify(data);

            headers['Content-Type'] = 'application/json';
            headers['Content-Length'] = Buffer.byteLength(postData);
        }
    }

    return new Promise((resolve, reject) => {
        const o = {
            headers: headers,
            method: method,
        };

        if (this.options.port) {
            o.port = this.options.port;
        }

        if (this.options.timeout) {
            o.timeout = this.options.timeout;
        }

        const h = this.isHttps ? require('https') : require('http');

        const req = h.request(url, o, res => {
            let data = '';

            res.on('data', chunk => {
                data += chunk;
            });

            res.on('end', () => {
                if (res.statusCode < 200 || res.statusCode > 299) {
                    reject(res);

                    return;
                }

                try {
                    data = JSON.parse(data);
                } catch (e) {
                    console.error(`Error: Could not parse response`);
                    reject({});

                    return;
                }

                resolve(data, res);
            });
        });

        req.on('error', e => {
            console.error(`Error: ${e.message}`);

            reject(e);
        });

        if (data && method !== 'GET') {
            req.write(postData);
        }

        req.end();
    });
}
```

#### `_buildUrl` Method

Internal helper method to construct the full API endpoint URL.

```javascript
_buildUrl(action) {
    return this.url + this.urlPath + action;
}
```

### Module Export
Exports the `Client` class for use in other Node.js modules.

```javascript
if (module && module.exports) {
    module.exports = Client;
}
```
```

--------------------------------

### EspoCRM Installation with SSL/TLS

Source: https://docs.espocrm.com/administration/installation-by-script

Use this command to install EspoCRM with an SSL/TLS certificate enabled.

```bash
wget -N https://github.com/espocrm/espocrm-installer/releases/latest/download/install.sh
sudo bash install.sh --ssl
```
Tokens:
Raw