本文档旨在指导开发者如何使用 Akeneo 5 的 API 获取产品的媒体资源。我们将使用 akeneo/api-php-client-ee 客户端，通过产品数据中的资产代码，找到对应的资产信息，并最终下载相关的媒体文件。本文将提供详细的代码示例，并解释如何根据资产家族代码和资产代码获取媒体资源，以及如何下载媒体文件。
获取产品并提取资产信息
首先，我们需要获取产品数据。以下代码展示了如何使用 akeneo/api-php-client-ee 客户端获取产品，并从中提取资产信息：
<?php
use Akeneo\Pim\ApiClient\Search\SearchBuilder;
// 假设 $client 已经初始化，是 Akeneo API 客户端实例
// 例如： $client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('your_akeneo_url')->buildAuthenticatedByClientCredentials('your_client_id', 'your_secret', 'your_username', 'your_password');
$searchBuilder = new SearchBuilder();
$searchBuilder->addFilter('enabled', '=', true);
$searchFilters = $searchBuilder->getFilters();
$products = $client->getProductApi()->all(100, ['search' => $searchFilters]);
foreach ($products as $product) {
if (isset($product['values']['assets'])) {
foreach($product['values']['assets'] as $assetData) {
foreach($assetData['data'] as $code) {
echo "Asset Code: " . $code . PHP_EOL;
// 在这里调用获取资产信息和下载媒体文件的函数
downloadProductAssets($client, $code);
}
}
}
}
/**
* @param \Akeneo\Pim\ApiClient\Api\Asset\AssetManagerApi $client
* @param string $code
* @return void
*/
function downloadProductAssets(\Akeneo\Pim\ApiClient\AkeneoPimClient $client, string $code)
{
$assetFamilyCode = 'bilder'; // 替换为你的资产家族代码
try {
$assets = $client->getAssetManagerApi()->get($assetFamilyCode, $code);
// 处理 'media' 类型的资产
if (isset($assets['values']['media'])) {
foreach($assets['values']['media'] as $dataLine) {
$mediaCode = $dataLine['data'];
$download = $client->getAssetMediaFileApi()->download($mediaCode);
$filePath = '/tmp/' . basename($mediaCode);
file_put_contents($filePath, $download->getBody());
echo "Downloaded media asset to: " . $filePath . PHP_EOL;
}
}
// 处理 'variation_image' 类型的资产
if (isset($assets['values']['variation_image'])) {
foreach($assets['values']['variation_image'] as $dataLine) {
$mediaCode = $dataLine['data'];
$download = $client->getAssetMediaFileApi()->download($mediaCode);
$filePath = '/tmp/' . basename($mediaCode);
file_put_contents($filePath, $download->getBody());
echo "Downloaded variation image asset to: " . $filePath . PHP_EOL;
}
}
} catch (\Akeneo\Pim\ApiClient\Exception\NotFoundException $e) {
echo "Asset with code " . $code . " not found in family " . $assetFamilyCode . PHP_EOL;
}
}代码解释：
- 初始化搜索构建器： 使用 SearchBuilder 创建一个搜索条件，这里我们筛选了 enabled 属性为 true 的产品。
- 获取产品列表： 使用 $client->getProductApi()->all() 方法获取产品列表。第一个参数是每页返回的产品数量，第二个参数是搜索条件。
- 遍历产品和资产： 遍历每个产品，检查是否存在 assets 属性。如果存在，则进一步遍历 assets 中的 data 数组，获取资产代码。
- 获取资产信息： 使用 $client->getAssetManagerApi()->get($assetFamilyCode, $code) 方法，根据资产家族代码和资产代码获取资产的详细信息。 注意： 需要替换 'bilder' 为你实际的资产家族代码。
- 下载媒体文件： 遍历资产信息中的 media 和 variation_image 属性，获取媒体文件的代码，并使用 $client->getAssetMediaFileApi()->download($mediaCode) 方法下载媒体文件。最后，将文件保存到本地。
注意事项
- 替换资产家族代码： 在实际使用中，需要将代码中的 'bilder' 替换为你实际的资产家族代码。可以通过 Akeneo 后台管理界面查看资产家族代码。
- 错误处理： 在获取资产信息和下载媒体文件时，应该添加适当的错误处理机制，例如使用 try-catch 块捕获 NotFoundException 异常，以处理资产不存在的情况。
- API 认证： 确保 $client 对象已经正确初始化，并且已经通过 API 客户端 ID 和密钥进行了身份验证。
- 目录权限： 确保保存媒体文件的目录（例如 /tmp/）具有写入权限。
- 资产类型： 此示例代码处理了 media 和 variation_image 两种类型的资产。如果你的产品中存在其他类型的资产，需要相应地修改代码。
- API 版本兼容性: 确保使用的 akeneo/api-php-client-ee 版本与 Akeneo 版本兼容。
总结
本文档介绍了如何使用 Akeneo 5 的 API 获取产品的媒体资源。通过产品数据中的资产代码，我们可以找到对应的资产信息，并最终下载相关的媒体文件。需要注意的是，在实际使用中，需要替换资产家族代码，并添加适当的错误处理机制。通过本文档的学习，开发者可以更好地理解和使用 Akeneo API，实现更加灵活和强大的产品数据管理功能。
