How to configure API Integrations
+ +Overview
++ Binner currently supports Binner Swarm, Digikey, Mouser, Octopart and AliExpress. For standalone installations, you will need to obtain your own API keys to enable these features. It's easy to obtain them but be aware Octopart is not free so you may want to avoid using it. Alternatively you can use Binner.io if you do not wish to worry about configuring external API's. +
++ Integrations enable features such as automatic part metadata lookup, datasheet retrieval and automatic importing parts from your orders. To get the best out of Binner, it is a good idea to sign up for Digikey and Mouser API keys at a minimum however they are not required. +
++ Configuration values can be found in appsettings.json alongside the Binner executable. +
+ + +Configuring Binner Swarm API
+ ++ Binner comes with free Swarm API support built-in. Swarm is an aggregate of part information that includes parametrics, datasheets, product images, pinouts and schematics. It is a new service, so content is still being expanded and indexed so a lot more data will be coming in the near future. There is a limit on how many Swarm requests can be made per hour/day - if you feel you need larger limits you can signup for a free or paid account at https://binner.io/swarm and your limits are increased accordingly. +
+ +Settings example
+// appsettings.json
+{JSON.stringify({ Integrations: {
+ Swarm: {
+ Enabled: true,
+ ApiKey: "",
+ ApiUrl: "https://swarm.binner.io",
+ },
+},}, null, 2)}
Configuring DigiKey API
++ Visit https://developer.digikey.com and sign up for a free developer account. You will be asked to create an App which will come with a ClientId and ClientSecret and needs to be set in the appsettings.json under the DigiKey configuration section. +
+ +Creating an App
+ +
+ Figure 1. DigiKey's api settings, located in the DigiKey api developers portal
+ Sandbox
+ +If you wish to use the DigiKey sandbox rather than their production API, you can specify the ApiUrl to use https://sandbox-api.digikey.com. Otherwise, you can leave it set to https://api.digikey.com
+ +Settings example
+// appsettings.json
+{JSON.stringify({ Integrations: {
+ Digikey: {
+ Enabled: true,
+ ClientId: "KsGAFuZGErn4zgvFDI9ux4nW3vZ63H3r",
+ ClientSecret: "IAbQsT4GCnagahrH",
+ oAuthPostbackUrl: "https://localhost:8090/Authorization/Authorize",
+ ApiUrl: "https://api.digikey.com",
+ },
+},}, null, 2)}
Configuring Mouser API
+Visit https://www.mouser.com/api-hub and sign up for a free developer account. Mouser requires you to sign up for each API product you wish to use. Currently, Binner supports both the Search API and Order API so sign up for those two APIs separately. Once you have an API key for each, set those in the appsettings.json under the Mouser configuration section.
+ +Settings example
+// appsettings.json
+{JSON.stringify({ Integrations: {
+ Mouser: {
+ Enabled: true,
+ ApiKeys: {
+ SearchApiKey: "84e40c37-99de-4990-86c2-290749dc7f52",
+ OrderApiKey: "2d1a00d7-16fd-4979-b7e3-5ca384711ab2",
+ CartApiKey: ""
+ },
+ ApiUrl: "https://api.mouser.com"
+ },
+},}, null, 2)}
Configuring Octopart API
+Visit https://octopart.com/api/home and sign up for a developer account. Please note that Octopart API is not free to use so you may opt to skip this one. They don't advertise pricing until you start using the API (sneaky), but if you already have a key it can be used for additional datasheet support. If you do not wish to use it Digikey and Mouser will be used to access datasheets for parts, as well as the free Binner datasheet API.
+ +Settings example
+// appsettings.json
+{JSON.stringify({ Integrations: {
+ Octopart: {
+ Enabled: true,
+ ApiKey: "b3h5632j245jh5521426",
+ ApiUrl: "https://octopart.com"
+ },
+},}, null, 2)}
- Barcode Scanning
Learn more about what types of features are available using a handheld barcode scanner.
+ - Api Integrations
Configuring Api integrations are an important part of using Binner effectively.
- Wiki
Get more help from the wiki on GitHub
Mouser
-
- Mouser uses different types of barcodes for it's various paperwork and labeling. Invoices use a standard code-128 barcode which can be scanned on the Order Import page.
- Parts use a 2D DotMatrix barcode so you must have a scanner that supports 2D barcodes.
+
+ Mouser barcode scanning support is coming soon! Look for it in the next feature release.
-Scanning Parts
- By scanning the 2D Dotmatrix barcode on a part label you can:-
-
-
- Search for parts in your inventory on the Search page -
- Add new parts to your inventory on the Add Inventory page -
- Bulk import new parts on the Add Inventory page -
- Example 1. This is a 2D DotMatrix barcode on a standard Mouser part label.
- Importing Orders
- -
- On the Order Import page you can scan one of your past orders to import all parts in the order at once.
- To do so, you will need the Mouser packing list for your order. The invoice doesn't contain the barcodes you want, however you can type in the Sales Order Number manually easily as well.
-
-
- Example 2. There are multiple 1D code-128 barcodes, and several 2D DotMatrix barcodes on a standard Mouser packing list.
- The Sales Order number can be scanned (top right) to import the entire - or parts of an order. You can also scan the 2D DotMatrix barcodes which provide the same information.
-Additionally, each itemized part can be scanned in the packing list but this is only supported on the Add Inventory page. Note there is a barcode for both the part as well as a smaller barcode for its quantity.
-