hubspot-api-php
PHP HubSpot API v3 SDK(Client) files
Installation
composer require hubspot/api-client
Sample apps
Please, take a look at our Sample apps
Quickstart
To instantiate API Client using HubSpot API Key use Factory:
$hubSpot = \HubSpot\Factory::createWithApiKey('api-key');
or using OAuth2 access token:
$hubSpot = \HubSpot\Factory::createWithAccessToken('access-token');
also you can pass custom client to Factory:
$client = new \GuzzleHttp\Client([...]);
$hubSpot = \HubSpot\Factory::createWithAccessToken('access-token', $client);
API Client comes with Middleware for implementation of Rate and Concurrent Limiting.
It provides an ability to turn on retry for failed requests with statuses 429 or 500. Please note that Apps using OAuth are only subject to a limit of 100 requests every 10 seconds.
$handlerStack = \GuzzleHttp\HandlerStack::create();
$handlerStack->push(
\HubSpot\RetryMiddlewareFactory::createRateLimitMiddleware(
\HubSpot\Delay::getConstantDelayFunction()
)
);
$handlerStack->push(
\HubSpot\RetryMiddlewareFactory::createInternalErrorsMiddleware(
\HubSpot\Delay::getExponentialDelayFunction(2)
)
);
$client = new \GuzzleHttp\Client(['handler' => $handlerStack]);
$hubSpot = \HubSpot\Factory::createWithAccessToken('access-token', $client);
Get contacts page:
$response = $hubSpot->crm()->contacts()->basicApi()->getPage();
Search for a contact:
$filter = new \HubSpot\Client\Crm\Contacts\Model\Filter();
$filter
->setOperator('EQ')
->setPropertyName('email')
->setValue($search);
$filterGroup = new \HubSpot\Client\Crm\Contacts\Model\FilterGroup();
$filterGroup->setFilters([$filter]);
$searchRequest = new \HubSpot\Client\Crm\Contacts\Model\PublicObjectSearchRequest();
$searchRequest->setFilterGroups([$filterGroup]);
// @var CollectionResponseWithTotalSimplePublicObject $contactsPage
$contactsPage = $hubSpot->crm()->contacts()->searchApi()->doSearch($searchRequest);
Create a contact:
$contactInput = new \HubSpot\Client\Crm\Contacts\Model\SimplePublicObjectInput();
$contactInput->setProperties([
'email' => 'example@example.com'
]);
$contact = $hubSpot->crm()->contacts()->basicApi()->create($contactInput);
Update a contact:
$newProperties = new \HubSpot\Client\Crm\Contacts\Model\SimplePublicObjectInput();
$newProperties->setProperties($[
'email' => 'updatedExample@example.com'
]);
$hubSpot->crm()->contacts()->basicApi()->update($contactId, $newProperties);
Archive a contact:
$hubSpot->crm()->contacts()->basicApi()->archive($contactId);
Get custom objects page:
$hubSpot->crm()->objects()->basicApi()->getPage(HubSpot\Crm\ObjectType::CONTACTS)
File uploading
$file = new \SplFileObject(“file path”);
$response = $hubSpot->files()->filesApi()->upload($file, null, ‘/’, null, null, json_encode([
“access” => “PRIVATE”,
“ttl” => “P2W”,
“overwrite” => false,
“duplicateValidationStrategy” => “NONE”,
“duplicateValidationScope” => “EXACT_FOLDER”
]) );
Contributing
Run spec tests
vendor/bin/phpspec run
Run unit tests
vendor/bin/phpunit ./tests