README

PHP 客户端库，用于使用 Exact Online API。

注意：对于 Guzzle 6 使用 v3，对于 Guzzle 3 使用 v1。

直接链接到 Exact Online 文档

https://support.exactonline.com/community/s/knowledge-base#All-All-DNO-Content-getting-started

Composer 安装

可以通过 Composer 安装此 PHP 客户端。

composer require CrixuAMG/exact-php-client

用法

1. 在 Exact App Center 上设置应用以获取凭证
2. 从您的应用中授权集成
3. 解析回调并完成连接设置
4. 使用库执行操作

步骤 1-3 在设置时只需执行一次。

在 Exact App Center 上设置应用以获取凭证

在 Exact App Center 上设置应用以获取您的 Client ID 和 Client Secret。您还需要设置正确的 回调 URL 以使 OAuth 舞蹈生效。

从您的应用中授权集成

下面的代码是一个示例 authorize() 函数。

$connection = new \CrixuAMG\Financials\Exact\Connection();
$connection->setRedirectUrl('CALLBACK_URL'); // Same as entered online in the App Center
$connection->setExactClientId('CLIENT_ID');
$connection->setExactClientSecret('CLIENT_SECRET');
$connection->redirectForAuthorization();

这将使用户重定向到 Exact 进行登录并授权您的集成。

解析回调并完成连接设置

Exact 将重定向回您提供的 回调 URL。回调将接收一个 code 参数。这是 OAuth 的授权码。请保存此代码。

创建一个新的 Exact 连接，以便库可以交换代码并获取 accesstoken 和 refreshtoken。accesstoken 是一个临时令牌，允许您的应用与 Exact 通信。refreshtoken 是一个令牌，用于获取新的 accesstoken 并刷新 refreshtoken。库将为您处理所有这些。下面的代码可以是一个通用的 connect() 函数，它返回 API 连接。

$connection = new \CrixuAMG\Financials\Exact\Connection();
$connection->setRedirectUrl('CALLBACK_URL');
$connection->setExactClientId('CLIENT_ID');
$connection->setExactClientSecret('CLIENT_SECRET');

if (getValue('authorizationcode')) // Retrieves authorizationcode from database
	$connection->setAuthorizationCode(getValue('authorizationcode'));

if (getValue('accesstoken')) // Retrieves accesstoken from database
	$connection->setAccessToken(unserialize(getValue('accesstoken')));

if (getValue('refreshtoken')) // Retrieves refreshtoken from database
	$connection->setRefreshToken(getValue('refreshtoken'));

if (getValue('expires_in'))  // Retrieves expires timestamp from database
	$connection->setTokenExpires(getValue('expires_in'));

// Make the client connect and exchange tokens
try {
	$connection->connect();
} catch (\Exception $e)
{
	throw new Exception('Could not connect to Exact: ' . $e->getMessage());
}

// Save the new tokens for next connections
setValue('accesstoken', serialize($connection->getAccessToken()));
setValue('refreshtoken', $connection->getRefreshToken());

// Optionally, save the expiry-timestamp. This prevents exchanging valid tokens (ie. saves you some requests)
setValue('expires_in', $connection->getTokenExpires());

// Optionally, set the lock and unlock callbacks to prevent multiple request for acquiring a new refresh token with the same refresh token.
$connection->setAcquireAccessTokenLockCallback('CALLBACK_FUNCTION');
$connection->setAcquireAccessTokenUnlockCallback('CALLBACK_FUNCTION');

关于部门（管理）

默认情况下，库将使用用户的默认管理。这意味着当用户在 Exact Online 中切换部门时，库也将开始使用此部门。

速率限制

Exact 使用每分钟和每日速率限制。您每天可以针对每个公司进行最大次数的调用，并且为了防止超量使用，他们还实施了一分钟的限制。此 PR 将此信息存储在 Connection 中，并添加了读取速率限制的方法，以便您可以根据您的应用适当处理这些限制。有关速率限制的 Exact 文档可在此处找到：[https://support.exactonline.com/community/s/knowledge-base#All-All-DNO-Simulation-gen-apilimits](https://support.exactonline.com/community/s/knowledge-base#All-All-DNO-Simulation-gen-apilimits)

如果您遇到速率限制，将抛出一个带有代码 429 的 ApiException。在这种情况下，您可以确定是遇到了每分钟限制还是每日限制。如果您遇到了每分钟限制，请在一分钟后再次尝试。如果您遇到了每日限制，请在每日重置后再次尝试。

您可以在 Connection 上使用以下方法，这些方法将在您的第一次 API 调用后返回限制（基于 Exact 的头信息）。

$connection->getDailyLimit(); // Retrieve your daily limit
$connection->getDailyLimitRemaining(); // Retrieve the remaining amount of API calls for this day
$connection->getDailyLimitReset(); // Retrieve the timestamp for when the limit will reset
$connection->getMinutelyLimit(); // Retrieve your limit per minute
$connection->getMinutelyLimitRemaining(); // Retrieve the amount of API calls remaining for this minute

使用库执行操作（示例）

// Optionally set administration, otherwise use the current administration of the user
$connection->setDivision(123456);

// Create a new account
$account = new Account($connection);
$account->AddressLine1 = $customer['address'];
$account->AddressLine2 = $customer['address2'];
$account->City = $customer['city'];
$account->Code = $customer['customerid'];
$account->Country = $customer['country'];
$account->IsSales = 'true';
$account->Name = $customer['name'];
$account->Postcode = $customer['zipcode'];
$account->Status = 'C';
$account->save();

// Add a product in Exact
$item = new Item($connection);
$item->Code = $productcode;
$item->CostPriceStandard = $costprice;
$item->Description = $name;
$item->IsSalesItem = true;
$item->SalesVatCode = 'VH';
$item->save();

// Retrieve an item
$item = new Item($connection);
$item->find(ID);

// List items
$item = new Item($connection);
$item->get();

// List items with filter (using a filter always returns a collection)
$item = new Item($connection);
$items = $item->filter("Code eq '$productcode'"); // Uses filters as described in Exact API docs (odata filters)

// Create new invoice with invoice lines
$invoiceLines[] = [
	'Item'      => $itemId,
	'Quantity'  => $orderproduct['amount'],
	'UnitPrice' => $orderproduct['price']
];

$salesInvoice = new SalesInvoice($connection);
$salesInvoice->InvoiceTo = $customer_code;
$salesInvoice->OrderedBy = $customer_code;
$salesInvoice->YourRef = $orderId;
$salesInvoice->SalesInvoiceLines = $invoiceLines;
$salesInvoice->save();

// Print and email the invoice
$printedInvoice = new PrintedSalesInvoice($connection);
$printedInvoice->InvoiceID = $salesInvoice->InvoiceID;
$printedInvoice->SendEmailToCustomer = true;
$printedInvoice->SenderEmailAddress = "from@example.com";
$printedInvoice->DocumentLayout = "401f3020-35cd-49a2-843a-d904df0c09ff";
$printedInvoice->ExtraText = "Some additional text";
$printedInvoice->save();

连接到荷兰以外的其他 Exact 国家

根据 Exact 开发者指南 选择正确的基础 URL

$connection = new \CrixuAMG\Financials\Exact\Connection();
$connection->setRedirectUrl('CALLBACK_URL');
$connection->setExactClientId('CLIENT_ID');
$connection->setExactClientSecret('CLIENT_SECRET');
$connection->setBaseUrl('https://start.exactonline.de');

检查 src/CrixuAMG/Financials/Exact 中的所有可用实体。

Webhooks

通过WebhookSubscription实体可以管理webhook订阅。

为了验证传入的webhook调用，可以使用Authenticatable特性。将完整的JSON请求和Exact提供的Webhook secret提供给认证方法，它将返回true或false。

故障排除

出现带有消息“错误 400：请向查询字符串添加 $select 或 $top=1 语句”的'CrixuAMG\Financials\Exact\ApiException'。

在某些特定情况下，遗憾的是Exact API文档中没有记录这一点，这是必需的。可能是为了防止请求过载。遇到此错误时，您需要添加select或top。select用于提供要提取的字段列表，$top=1将结果限制为一条项目。

示例

仅返回EntryID和FinancialYear。

$test = new GeneralJournalEntry($connection);
var_dump($test->filter('', '', 'EntryID, FinancialYear'));

$top=1的添加方式如下

$test = new GeneralJournalEntry($connection);
var_dump($test->filter('', '', '', ['$top'=> 1]));

认证错误

错误：未捕获异常：无法连接到Exact：客户端错误：POST https://start.exactonline.nl/api/oauth2/token 返回了400 Bad Request响应：Bad Request in /var/www/html/oauth_call_connect.php:61

此错误发生是因为您在重定向URL中获得的代码仅对一次调用有效。当您再次使用“已使用”的代码调用认证过程时，您会得到此错误。请确保您只使用Exact Online提供的代码一次以获取访问令牌。

代码示例

例如查看：example/example.php

待办事项

• 当前实体不包含所有可用的属性。如果您需要它们，请随时提交带有添加或扩展实体的PR。使用greasemonkey或tampermonkey中的userscript.js生成一致且完整的实体。