System Information

• PartKeepr Version: v1.2.0
• Reproducible on the demo system: No (as I don't have the ability to modify the configuration on the demo system and Octopart integration appears to be functioning there.)

How to reproduce

I have a very limited understanding of how the Octopart API key gets pushed into the system so I'm making some assumptions as I write this (some of which may be incorrect) so please bear with me. Also, I'll be using 'xxxxxxxx' in lieu of my real Octopart API key in this bug report.

I ran into an issue while attempting to setup Octopart support for my PartKeepr v1.2.0 installation. I started by simply following the instructions in the app/config/parameters.php.dist, which say to set the Octopart API property in the parameters.php file:

$container->setParameter('partkeepr.octopart.apikey', 'xxxxxxxx')`

Doing this seemed to have no effect and didn't enable Octopart support in PartKeepr. Eventually, I went back and ran the web/setup again, which then failed at the "Retrieving Existing Configuration" step with the error message "Invalid Authentication Key." On a whim, I set the partkeepr.octopart.apikey property as follows:

$container->setParameter('partkeepr.octopart.apikey', 'https://octopart.com/api/v3/parts/match?apikey='xxxxxxxx')`

I then reran the web/setup tool and was able to successfully make it past the "Retrieving Existing Configuration" step without any errors and then was able to continue through the rest of the setup process successfully; however, after logging back into PartKeepr, pulling up the detail window for an item and clicking the Octopart button, the Octopart window appeared but was completely empty (note there were no error messages displayed in the UI.) A quick look at the partkeepr.log showed the following error:

request.CRITICAL: Uncaught PHP Exception Guzzle\Http\Exception\ClientErrorResponseException: "Client error response [status code] 401 [reason phrase] Unauthorized [url] http://octopart.com/api/v3/parts/search?apikey=https%3A%2F%2Foctopart.com%2Fapi%2Fv3%2Fparts%2Fmatch%3Fapikey%3Dxxxxxxxx&q=STD950BLK&start=0&include%5B0%5D=short_description&include%5B1%5D=specs&include%5B2%5D=datasheets&limit=20" at /var/www/partkeepr.domain.com/vendor/guzzle/guzzle/src/Guzzle/Http/Exception/BadResponseException.php line 43 {"exception":"[object] (Guzzle\\Http\\Exception\\ClientErrorResponseException(code: 0): Client error response\n[status code] 401\n[reason phrase] Unauthorized\n[url] http://octopart.com/api/v3/parts/search?apikey=https%3A%2F%2Foctopart.com%2Fapi%2Fv3%2Fparts%2Fmatch%3Fapikey%3Dxxxxxxxx&q=STD950BLK&start=0&include%5B0%5D=short_description&include%5B1%5D=specs&include%5B2%5D=datasheets&limit=20 at /var/www/partkeepr.domain.com/vendor/guzzle/guzzle/src/Guzzle/Http/Exception/BadResponseException.php:43)"} []

From the log message above, the problem appears to be an issue with the web/setup's apikey verification/validation. It would seem that process needs the full Octopart URL endpoint (with the apikey included as a URL parameter) in order to be validated; however, PartKeepr itself only wants the standalone apikey string specified at runtime for substitution, which makes sense as the URL for the API is specified in the const OCTOPART_ENDPOINT in /src/PartKeepr/OctoPartBundle/Services/OctoPartService.php.

The workaround for this (at least the one I used for the time being) is to leave the full Octopart API endpoint (with the API key included as a URL parameter) in the parameters.php for the setup process, which seems to need to complete successfully in order to convince PartKeepr that Octopart support is enabled. Then I modified the /src/PartKeepr/OctoPartBundle/Services/OctoPartService.php file by assigning the apiKey to a string literal, representing my Octopart API key (as shown below):

public function __construct($apiKey) { $this->apiKey = "xxxxxxxx"; }

I think the fix for this is to correct the validation of the API key in the web/setup utility but I'm not sure. My apologies if I've misunderstood something or how this process all works.

Cheers!