mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-21 09:35:49 +02:00
Improved digikey provider
This commit is contained in:
parent
f7648e3311
commit
01d9109c45
2 changed files with 87 additions and 8 deletions
|
@ -13,6 +13,11 @@ knpu_oauth2_client:
|
||||||
redirect_params: {name: 'ip_digikey_oauth'}
|
redirect_params: {name: 'ip_digikey_oauth'}
|
||||||
|
|
||||||
provider_options:
|
provider_options:
|
||||||
urlAuthorize: 'https://sandbox-api.digikey.com/v1/oauth2/authorize'
|
urlAuthorize: 'https://api.digikey.com/v1/oauth2/authorize'
|
||||||
urlAccessToken: 'https://sandbox-api.digikey.com/v1/oauth2/token'
|
urlAccessToken: 'https://api.digikey.com/v1/oauth2/token'
|
||||||
urlResourceOwnerDetails: ''
|
urlResourceOwnerDetails: ''
|
||||||
|
|
||||||
|
# Sandbox
|
||||||
|
#urlAuthorize: 'https://sandbox-api.digikey.com/v1/oauth2/authorize'
|
||||||
|
#urlAccessToken: 'https://sandbox-api.digikey.com/v1/oauth2/token'
|
||||||
|
#urlResourceOwnerDetails: ''
|
||||||
|
|
|
@ -24,7 +24,10 @@ declare(strict_types=1);
|
||||||
namespace App\Services\InfoProviderSystem\Providers;
|
namespace App\Services\InfoProviderSystem\Providers;
|
||||||
|
|
||||||
use App\Entity\Parts\ManufacturingStatus;
|
use App\Entity\Parts\ManufacturingStatus;
|
||||||
|
use App\Services\InfoProviderSystem\DTOs\ParameterDTO;
|
||||||
use App\Services\InfoProviderSystem\DTOs\PartDetailDTO;
|
use App\Services\InfoProviderSystem\DTOs\PartDetailDTO;
|
||||||
|
use App\Services\InfoProviderSystem\DTOs\PriceDTO;
|
||||||
|
use App\Services\InfoProviderSystem\DTOs\PurchaseInfoDTO;
|
||||||
use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
|
use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
|
||||||
use App\Services\OAuth\OAuthTokenManager;
|
use App\Services\OAuth\OAuthTokenManager;
|
||||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||||
|
@ -34,18 +37,24 @@ class DigikeyProvider implements InfoProviderInterface
|
||||||
|
|
||||||
private const OAUTH_APP_NAME = 'ip_digikey_oauth';
|
private const OAUTH_APP_NAME = 'ip_digikey_oauth';
|
||||||
|
|
||||||
|
//Sandbox:'https://sandbox-api.digikey.com'; (you need to change it in knpu/oauth2-client-bundle config too)
|
||||||
|
private const BASE_URI = 'https://api.digikey.com';
|
||||||
|
|
||||||
|
private const VENDOR_NAME = 'DigiKey';
|
||||||
|
|
||||||
private readonly HttpClientInterface $digikeyClient;
|
private readonly HttpClientInterface $digikeyClient;
|
||||||
|
|
||||||
public function __construct(HttpClientInterface $httpClient, private readonly OAuthTokenManager $authTokenManager, string $currency, private readonly string $clientId)
|
|
||||||
|
public function __construct(HttpClientInterface $httpClient, private readonly OAuthTokenManager $authTokenManager, private readonly string $currency, private readonly string $clientId)
|
||||||
{
|
{
|
||||||
//Create the HTTP client with some default options
|
//Create the HTTP client with some default options
|
||||||
$this->digikeyClient = $httpClient->withOptions([
|
$this->digikeyClient = $httpClient->withOptions([
|
||||||
"base_uri" => 'https://sandbox-api.digikey.com',
|
"base_uri" => self::BASE_URI,
|
||||||
"headers" => [
|
"headers" => [
|
||||||
"X-DIGIKEY-Client-Id" => $clientId,
|
"X-DIGIKEY-Client-Id" => $clientId,
|
||||||
"X-DIGIKEY-Locale-Site" => 'DE',
|
"X-DIGIKEY-Locale-Site" => 'DE',
|
||||||
"X-DIGIKEY-Locale-Language" => 'de',
|
"X-DIGIKEY-Locale-Language" => 'de',
|
||||||
"X-DIGIKEY-Locale-Currency" => $currency,
|
"X-DIGIKEY-Locale-Currency" => $this->currency,
|
||||||
"X-DIGIKEY-Customer-Id" => 0,
|
"X-DIGIKEY-Customer-Id" => 0,
|
||||||
]
|
]
|
||||||
]);
|
]);
|
||||||
|
@ -112,13 +121,40 @@ class DigikeyProvider implements InfoProviderInterface
|
||||||
mpn: $product['ManufacturerPartNumber'],
|
mpn: $product['ManufacturerPartNumber'],
|
||||||
preview_image_url: $product['PrimaryPhoto'] ?? null,
|
preview_image_url: $product['PrimaryPhoto'] ?? null,
|
||||||
manufacturing_status: $this->productStatusToManufacturingStatus($product['ProductStatus']),
|
manufacturing_status: $this->productStatusToManufacturingStatus($product['ProductStatus']),
|
||||||
provider_url: 'https://digikey.com'.$product['ProductUrl'],
|
provider_url: $product['ProductUrl'],
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
return $result;
|
return $result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function getDetails(string $id): PartDetailDTO
|
||||||
|
{
|
||||||
|
$response = $this->digikeyClient->request('GET', '/Search/v3/Products/' . $id, [
|
||||||
|
'auth_bearer' => $this->authTokenManager->getAlwaysValidTokenString(self::OAUTH_APP_NAME)
|
||||||
|
]);
|
||||||
|
|
||||||
|
$product = $response->toArray();
|
||||||
|
|
||||||
|
$footprint = null;
|
||||||
|
$parameters = $this->parametersToDTOs($product['Parameters'] ?? [], $footprint);
|
||||||
|
|
||||||
|
return new PartDetailDTO(
|
||||||
|
provider_key: $this->getProviderKey(),
|
||||||
|
provider_id: $product['DigiKeyPartNumber'],
|
||||||
|
name: $product['ManufacturerPartNumber'],
|
||||||
|
description: $product['DetailedDescription'] ?? $product['ProductDescription'],
|
||||||
|
manufacturer: $product['Manufacturer']['Value'] ?? null,
|
||||||
|
mpn: $product['ManufacturerPartNumber'],
|
||||||
|
preview_image_url: $product['PrimaryPhoto'] ?? null,
|
||||||
|
manufacturing_status: $this->productStatusToManufacturingStatus($product['ProductStatus']),
|
||||||
|
provider_url: $product['ProductUrl'],
|
||||||
|
footprint: $footprint,
|
||||||
|
parameters: $parameters,
|
||||||
|
vendor_infos: $this->pricingToDTOs($product['StandardPricing'] ?? [], $product['DigiKeyPartNumber'], $product['ProductUrl']),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Converts the product status from the Digikey API to the manufacturing status used in Part-DB
|
* Converts the product status from the Digikey API to the manufacturing status used in Part-DB
|
||||||
* @param string|null $dk_status
|
* @param string|null $dk_status
|
||||||
|
@ -138,8 +174,46 @@ class DigikeyProvider implements InfoProviderInterface
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getDetails(string $id): PartDetailDTO
|
/**
|
||||||
|
* This function converts the "Parameters" part of the Digikey API response to an array of ParameterDTOs
|
||||||
|
* @param array $parameters
|
||||||
|
* @param string|null $footprint_name You can pass a variable by reference, where the name of the footprint will be stored
|
||||||
|
* @return ParameterDTO[]
|
||||||
|
*/
|
||||||
|
private function parametersToDTOs(array $parameters, string|null &$footprint_name = null): array
|
||||||
{
|
{
|
||||||
// TODO: Implement getDetails() method.
|
$results = [];
|
||||||
|
|
||||||
|
$footprint_name = null;
|
||||||
|
|
||||||
|
foreach ($parameters as $parameter) {
|
||||||
|
if ($parameter['ParameterId'] === 1291) { //Meaning "Manufacturer given footprint"
|
||||||
|
$footprint_name = $parameter['Value'];
|
||||||
|
}
|
||||||
|
|
||||||
|
$results[] = ParameterDTO::parseValueIncludingUnit($parameter['Parameter'], $parameter['Value']);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $results;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts the pricing (StandardPricing field) from the Digikey API to an array of PurchaseInfoDTOs
|
||||||
|
* @param array $price_breaks
|
||||||
|
* @param string $order_number
|
||||||
|
* @param string $product_url
|
||||||
|
* @return PurchaseInfoDTO[]
|
||||||
|
*/
|
||||||
|
private function pricingToDTOs(array $price_breaks, string $order_number, string $product_url): array
|
||||||
|
{
|
||||||
|
$prices = [];
|
||||||
|
|
||||||
|
foreach ($price_breaks as $price_break) {
|
||||||
|
$prices[] = new PriceDTO(minimum_discount_amount: $price_break['BreakQuantity'], price: (string) $price_break['UnitPrice'], currency_iso_code: $this->currency);
|
||||||
|
}
|
||||||
|
|
||||||
|
return [
|
||||||
|
new PurchaseInfoDTO(distributor_name: self::VENDOR_NAME, order_number: $order_number, prices: $prices, product_url: $product_url)
|
||||||
|
];
|
||||||
}
|
}
|
||||||
}
|
}
|
Loading…
Add table
Add a link
Reference in a new issue