Skip to content

Commit c263899

Browse files
committed
Added documentation for OEMSecrets info provider
1 parent 8554be9 commit c263899

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/usage/information_provider_system.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,26 @@ An API key is not required, it is enough to enable the provider using the follow
212212
* `PROVIDER_LCSC_ENABLED`: Set this to `1` to enable the LCSC provider
213213
* `PROVIDER_LCSC_CURRENCY`: The currency you want to get prices in (see LCSC webshop for available currencies, default: `EUR`)
214214

215+
### OEMsecrets
216+
217+
The oemsecrets provider uses the [oemsecrets API](https://www.oemsecrets.com/) to search for parts and getting shopping
218+
information from them. Similar to octopart it aggregates offers from different distributors.
219+
220+
You can apply for a free API key on the [oemsecrets API page](https://www.oemsecrets.com/api/) and put the key you get
221+
in the Part-DB env configuration (see below).
222+
223+
The following env configuration options are available:
224+
225+
* `PROVIDER_OEMSECRETS_KEY`: The API key you got from oemsecrets (mandatory)
226+
* `PROVIDER_OEMSECRETS_COUNTRY_CODE`: The two-letter code of the country you want to get the prices for
227+
* `PROVIDER_OEMSECRETS_CURRENCY`: The currency you want to get prices in (optional, default: `EUR`)
228+
* `PROVIDER_OEMSECRETS_ZERO_PRICE`: If set to `1`, parts with a price of 0 will be included in the search results, otherwise
229+
they will be excluded (optional, default: `0`)
230+
* `PROVIDER_OEMSECRETS_SET_PARAM`: If set to `1`, the provider will try to extract parameters from the part description
231+
* `PROVIDER_OEMSECRETS_SORT_CRITERIA`: The criteria to sort the search results by. If set to 'C', it further sorts by
232+
completeness (prioritizing items with the most detailed information). If set to 'M', it further sorts by manufacturer name.
233+
If set to any other value, no sorting is performed.
234+
215235
### Custom provider
216236

217237
To create a custom provider, you have to create a new class implementing the `InfoProviderInterface` interface. As long

0 commit comments

Comments
 (0)