Apideck PHP SDK Skill
Overview
The Apideck Unified API provides a single integration layer to connect with 200+ third-party services across accounting, CRM, HRIS, file storage, ATS, e-commerce, and more. The official PHP SDK provides typed clients for all unified APIs.
Installation
composer require apideck-libraries/sdk-php
IMPORTANT RULES
- ALWAYS use the
apideck-libraries/sdk-php Composer package. DO NOT make raw Guzzle/curl calls to the Apideck API.
- ALWAYS pass security, app ID, and consumer ID via the builder when creating the client.
- USE
serviceId on requests to specify which downstream connector to use.
- ALWAYS handle errors with try/catch using
Errors\APIException as the base class.
- DO NOT store API keys in source code. Use environment variables.
Quick Start
<?php
use Apideck\Unify;
use Apideck\Unify\Models\Operations;
use Apideck\Unify\Models\Components;
$sdk = Unify\Apideck::builder()
->setConsumerId('your-consumer-id')
->setAppId('your-app-id')
->setSecurity(getenv('APIDECK_API_KEY'))
->build();
$request = new Operations\CrmContactsAllRequest(
serviceId: 'salesforce',
limit: 20,
);
$responses = $sdk->crm->contacts->list(request: $request);
foreach ($responses as $response) {
if ($response->httpMeta->response->getStatusCode() === 200) {
foreach ($response->getContactsResponse->data as $contact) {
echo $contact->name . "\n";
}
}
}
SDK Patterns
Client Setup
use Apideck\Unify;
$sdk = Unify\Apideck::builder()
->setConsumerId('your-consumer-id')
->setAppId('your-app-id')
->setSecurity(getenv('APIDECK_API_KEY'))
->build();
CRUD Operations
All resources follow the pattern: $sdk->{api}->{resource}->{operation}(request: $request).
use Apideck\Unify\Models\Operations;
use Apideck\Unify\Models\Components;
// LIST
$request = new Operations\CrmContactsAllRequest(
serviceId: 'salesforce',
limit: 20,
filter: new Components\ContactsFilter(email: 'john@example.com'),
sort: new Components\ContactsSort(
by: Components\ContactsSortBy::UpdatedAt,
direction: Components\SortDirection::Desc,
),
);
$responses = $sdk->crm->contacts->list(request: $request);
// CREATE
$request = new Operations\CrmContactsAddRequest(
serviceId: 'salesforce',
contact: new Components\ContactInput(
firstName: 'John',
lastName: 'Doe',
emails: [
new Components\Email(email: 'john@example.com', type: Components\EmailType::Primary),
],
phoneNumbers: [
new Components\PhoneNumber(number: '+1234567890', type: Components\PhoneNumberType::Mobile),
],
),
);
$response = $sdk->crm->contacts->create(request: $request);
// GET
$request = new Operations\CrmContactsOneRequest(
id: 'contact_123',
serviceId: 'salesforce',
);
$response = $sdk->crm->contacts->get(request: $request);
// UPDATE
$request = new Operations\CrmContactsUpdateRequest(
id: 'contact_123',
serviceId: 'salesforce',
contact: new Components\ContactInput(firstName: 'Jane'),
);
$response = $sdk->crm->contacts->update(request: $request);
// DELETE
$request = new Operations\CrmContactsDeleteRequest(
id: 'contact_123',
serviceId: 'salesforce',
);
$response = $sdk->crm->contacts->delete(request: $request);
Pagination
The list method returns a PHP Generator. Iterate with foreach:
$request = new Operations\AccountingInvoicesAllRequest(
serviceId: 'quickbooks',
limit: 50,
);
$responses = $sdk->accounting->invoices->list(request: $request);
foreach ($responses as $response) {
if ($response->httpMeta->response->getStatusCode() === 200) {
foreach ($response->getInvoicesResponse->data as $invoice) {
echo "{$invoice->number}: {$invoice->total}\n";
}
}
}
Error Handling
use Apideck\Unify\Models\Errors;
try {
$responses = $sdk->crm->contacts->list(request: $request);
foreach ($responses as $response) {
// handle response
}
} catch (Errors\BadRequestResponseThrowable $e) {
echo "Bad request: " . $e->getMessage() . "\n";
} catch (Errors\UnauthorizedResponseThrowable $e) {
echo "Unauthorized\n";
} catch (Errors\NotFoundResponseThrowable $e) {
echo "Not found\n";
} catch (Errors\PaymentRequiredResponseThrowable $e) {
echo "API limit reached\n";
} catch (Errors\UnprocessableResponseThrowable $e) {
echo "Validation error: " . $e->getMessage() . "\n";
} catch (Errors\APIException $e) {
echo "API error: " . $e->getMessage() . "\n";
}
Retry Configuration
use Apideck\Unify\Utils\Retry;
// Global
$sdk = Unify\Apideck::builder()
->setRetryConfig(
new Retry\RetryConfigBackoff(
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
retryConnectionErrors: false,
)
)
->setConsumerId('your-consumer-id')
->setAppId('your-app-id')
->setSecurity(getenv('APIDECK_API_KEY'))
->build();
API Namespaces
| Namespace |
Resources |
$sdk->accounting->* |
invoices, bills, payments, customers, suppliers, ledgerAccounts, journalEntries, taxRates, creditNotes, purchaseOrders, balanceSheet, profitAndLoss, and more |
$sdk->crm->* |
contacts, companies, leads, opportunities, activities, notes, pipelines, users |
$sdk->hris->* |
employees, companies, departments, payrolls, timeOffRequests |
$sdk->fileStorage->* |
files, folders, drives, driveGroups, sharedLinks, uploadSessions |
$sdk->ats->* |
applicants, applications, jobs |
$sdk->vault->* |
connections, consumers, sessions, customMappings, logs |
$sdk->webhook->* |
webhooks, eventLogs |
1---2name: apideck-php3description: Apideck Unified API integration patterns for PHP. Use when building integrations with accounting software (QuickBooks, Xero, NetSuite), CRMs (Salesforce, HubSpot, Pipedrive), HRIS platforms (Workday, BambooHR), file storage (Google Drive, Dropbox, Box), ATS systems (Greenhouse, Lever), e-commerce, or any of Apideck's 200+ connectors using PHP. Covers the apideck-libraries/sdk-php Composer package, authentication, CRUD operations, pagination, error handling, and Vault connection management.4license: Apache-2.05alwaysApply: false6metadata:7 source: https://skillmd.com/skills/diegosouzapw/apideck-php8 author: apideck9 version: "1.0.0"10---1112# Apideck PHP SDK Skill1314## Overview1516The [Apideck Unified API](https://apideck.com) provides a single integration layer to connect with 200+ third-party services across accounting, CRM, HRIS, file storage, ATS, e-commerce, and more. The official PHP SDK provides typed clients for all unified APIs.1718## Installation1920```sh21composer require apideck-libraries/sdk-php22```2324## IMPORTANT RULES2526- ALWAYS use the `apideck-libraries/sdk-php` Composer package. DO NOT make raw `Guzzle`/`curl` calls to the Apideck API.27- ALWAYS pass security, app ID, and consumer ID via the builder when creating the client.28- USE `serviceId` on requests to specify which downstream connector to use.29- ALWAYS handle errors with try/catch using `Errors\APIException` as the base class.30- DO NOT store API keys in source code. Use environment variables.3132## Quick Start3334```php35<?php3637use Apideck\Unify;38use Apideck\Unify\Models\Operations;39use Apideck\Unify\Models\Components;4041$sdk = Unify\Apideck::builder()42 ->setConsumerId('your-consumer-id')43 ->setAppId('your-app-id')44 ->setSecurity(getenv('APIDECK_API_KEY'))45 ->build();4647$request = new Operations\CrmContactsAllRequest(48 serviceId: 'salesforce',49 limit: 20,50);5152$responses = $sdk->crm->contacts->list(request: $request);5354foreach ($responses as $response) {55 if ($response->httpMeta->response->getStatusCode() === 200) {56 foreach ($response->getContactsResponse->data as $contact) {57 echo $contact->name . "\n";58 }59 }60}61```6263## SDK Patterns6465### Client Setup6667```php68use Apideck\Unify;6970$sdk = Unify\Apideck::builder()71 ->setConsumerId('your-consumer-id')72 ->setAppId('your-app-id')73 ->setSecurity(getenv('APIDECK_API_KEY'))74 ->build();75```7677### CRUD Operations7879All resources follow the pattern: `$sdk->{api}->{resource}->{operation}(request: $request)`.8081```php82use Apideck\Unify\Models\Operations;83use Apideck\Unify\Models\Components;8485// LIST86$request = new Operations\CrmContactsAllRequest(87 serviceId: 'salesforce',88 limit: 20,89 filter: new Components\ContactsFilter(email: 'john@example.com'),90 sort: new Components\ContactsSort(91 by: Components\ContactsSortBy::UpdatedAt,92 direction: Components\SortDirection::Desc,93 ),94);95$responses = $sdk->crm->contacts->list(request: $request);9697// CREATE98$request = new Operations\CrmContactsAddRequest(99 serviceId: 'salesforce',100 contact: new Components\ContactInput(101 firstName: 'John',102 lastName: 'Doe',103 emails: [104 new Components\Email(email: 'john@example.com', type: Components\EmailType::Primary),105 ],106 phoneNumbers: [107 new Components\PhoneNumber(number: '+1234567890', type: Components\PhoneNumberType::Mobile),108 ],109 ),110);111$response = $sdk->crm->contacts->create(request: $request);112113// GET114$request = new Operations\CrmContactsOneRequest(115 id: 'contact_123',116 serviceId: 'salesforce',117);118$response = $sdk->crm->contacts->get(request: $request);119120// UPDATE121$request = new Operations\CrmContactsUpdateRequest(122 id: 'contact_123',123 serviceId: 'salesforce',124 contact: new Components\ContactInput(firstName: 'Jane'),125);126$response = $sdk->crm->contacts->update(request: $request);127128// DELETE129$request = new Operations\CrmContactsDeleteRequest(130 id: 'contact_123',131 serviceId: 'salesforce',132);133$response = $sdk->crm->contacts->delete(request: $request);134```135136### Pagination137138The `list` method returns a PHP Generator. Iterate with `foreach`:139140```php141$request = new Operations\AccountingInvoicesAllRequest(142 serviceId: 'quickbooks',143 limit: 50,144);145146$responses = $sdk->accounting->invoices->list(request: $request);147148foreach ($responses as $response) {149 if ($response->httpMeta->response->getStatusCode() === 200) {150 foreach ($response->getInvoicesResponse->data as $invoice) {151 echo "{$invoice->number}: {$invoice->total}\n";152 }153 }154}155```156157### Error Handling158159```php160use Apideck\Unify\Models\Errors;161162try {163 $responses = $sdk->crm->contacts->list(request: $request);164 foreach ($responses as $response) {165 // handle response166 }167} catch (Errors\BadRequestResponseThrowable $e) {168 echo "Bad request: " . $e->getMessage() . "\n";169} catch (Errors\UnauthorizedResponseThrowable $e) {170 echo "Unauthorized\n";171} catch (Errors\NotFoundResponseThrowable $e) {172 echo "Not found\n";173} catch (Errors\PaymentRequiredResponseThrowable $e) {174 echo "API limit reached\n";175} catch (Errors\UnprocessableResponseThrowable $e) {176 echo "Validation error: " . $e->getMessage() . "\n";177} catch (Errors\APIException $e) {178 echo "API error: " . $e->getMessage() . "\n";179}180```181182### Retry Configuration183184```php185use Apideck\Unify\Utils\Retry;186187// Global188$sdk = Unify\Apideck::builder()189 ->setRetryConfig(190 new Retry\RetryConfigBackoff(191 initialInterval: 1,192 maxInterval: 50,193 exponent: 1.1,194 maxElapsedTime: 100,195 retryConnectionErrors: false,196 )197 )198 ->setConsumerId('your-consumer-id')199 ->setAppId('your-app-id')200 ->setSecurity(getenv('APIDECK_API_KEY'))201 ->build();202```203204## API Namespaces205206| Namespace | Resources |207|-----------|-----------|208| `$sdk->accounting->*` | invoices, bills, payments, customers, suppliers, ledgerAccounts, journalEntries, taxRates, creditNotes, purchaseOrders, balanceSheet, profitAndLoss, and more |209| `$sdk->crm->*` | contacts, companies, leads, opportunities, activities, notes, pipelines, users |210| `$sdk->hris->*` | employees, companies, departments, payrolls, timeOffRequests |211| `$sdk->fileStorage->*` | files, folders, drives, driveGroups, sharedLinks, uploadSessions |212| `$sdk->ats->*` | applicants, applications, jobs |213| `$sdk->vault->*` | connections, consumers, sessions, customMappings, logs |214| `$sdk->webhook->*` | webhooks, eventLogs |