Skip to content

API Client Implementation in PHP

Require Espo Api Client with Composer:

composer require espocrm/php-espo-api-client Before executing this script, create an API user with the needed permissions.

Usage

```php use Espo\ApiClient\Client;

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

// The second parameter is the path. $response = $client->request(Client::METHOD_POST, 'Lead', [ 'firstName' => 'Test', 'lastName' => 'Hello', ]);

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

$parsedBody = $response->getParsedBody();

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

Api Key Authentication

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

HMAC Authentication

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