入門
歡迎來到 Onlinecomponents.com API 套件!請依照以下步驟開始:
驗證
若要存取 Onlinecomponents.com API,您需要 API 金鑰。您可以從同一位置取得生產 API 金鑰和沙箱 API 金鑰:
- 導航至您的客戶資料
- 前往 API 存取和服務
- 請求您的 API 金鑰
登入您的 Onlinecomponents.com 帳戶並前往您的客戶資料
在客戶資料下,找到標示為「API 存取和服務」的部分。您也可以直接點選此處造訪API接入與服務頁面
從此部分請求 API 金鑰,在生產 API 金鑰或沙箱 API 金鑰之間進行選擇。您將立即收到鑰匙。如果您懷疑有任何安全問題,您可以隨時重新觸發並重新產生金鑰
沙箱環境
我們了解上線前測試的重要性。這就是為什麼我們提供功能齊全的沙箱環境,您可以在其中試驗我們的所有 API,而不會影響您的生產數據。
訪問沙盒
- 請求沙箱 API 金鑰
- 不同的基址
- https://api.onlinecomponents.com
- https://sandbox.onlinecomponents.com
- 沙箱開發者門戶
從 API 存取和服務頁面請求您的沙盒 API 金鑰。此密鑰與您的生產密鑰不同,專門用於沙箱測試。
雖然 API 端點保持不變,但沙箱環境使用不同的基本 URL。
透過沙盒開發者入口網站存取沙盒環境。在這裡,您將找到所有必要的文件、工具和支持,以幫助您有效地測試集成
搜尋介面
Onlinecomponents.com 搜尋 API 是一種強大且簡單的方法,可在您自己的應用程式中存取和利用 Onlinecomponents.com 產品資料、可用性和定價
描述
搜尋 API 服務可讓客戶在自己的應用程式中利用 Onlinecomponents.com 產品資料、可用性和定價。輕鬆搜尋超過 800 萬種產品和詳細的產品資訊。 JSON 資料格式現已可用於 Onlinecomponents.com 搜尋 API
-
我們有一個更快、更靈活的新版本搜尋 API:
- JSON 透過更清晰的回應資料提供更快的處理速度
- 資料格式更清晰,更容易在現代瀏覽器中顯示
- API 版本控制:請求和回應可以採用 JSON 或 XML 格式
特徵
- 即時存取
- 按關鍵字搜尋方法
- 依零件編號方法搜尋
- 每次呼叫最多回傳 50 個結果
- 每分鐘最多 100 次呼叫
- 每天最多 100,000 個呼叫
可用數據
- Product Id
- Part Number
- Manufacturer Name
- Description
- Datasheet Url
- Product Url
- Part Image
- Quantity Available
- On Order Quantity
- Factory Stock Quantity
- Factory Lead Time
- Availability
- Package Quantity
- Package Cross Quantity
- Product Sub Category
- Product Status
- RoHS
- Min Order Quantity
- Package Type
- Package Cross
- Multiple
- Unit Of Measure
- COO
- ECCN
- PRC
- HTS
- Main Category
- Sub Category
- Taxonomy
- Product Life Cycle
- Available less than min
- Alternative Parts
- Prices
端點
訂單介面
造訪 Onlinecomponents.com 結帳流程並在您自己的應用程式中訂購零件。
描述
訂單 API 可用於從 Onlinecomponents.com 下訂單和檢查訂單。 我們有一個更快、更靈活的新版本 Order API:
- JSON 透過更清晰的回應資料提供更快的處理速度
- 資料格式更清晰,更容易在現代瀏覽器中顯示
- API 版本控制:請求和回應可以採用 JSON 或 XML 格式
端點
訂單 API 可用於從 Onlinecomponents.com 下訂單和檢查訂單。
Request Parameters
| Parameter | Description | Required |
|---|---|---|
| The email address of the customer to be associated to the sales order | yes | |
| firstName | The first name of the customer | yes |
| lastName | The last name of the customer | yes |
| phoneNumber | The phone number for the order | yes |
| shippingMethod | yes | |
| accountNo | Shipping account no. | yes |
| carrier | No | |
| shippingInsurance | yes | |
| taxable | yes | |
| resaleNumber | No | |
| shippingAddress | The shipping address for the order | yes |
| shippingAddress.firstName | The first name to be used for the ship-to address | yes |
| shippingAddress.lastName | The last name to be used for the ship-to address | yes |
| shippingAddress.company | The company name to be used for the ship-to address | yes |
| shippingAddress.countryTwoletterISOCode | The two character country code to be used for the ship-to address (e.g. US) | yes |
| shippingAddress.stateProvinceAbbreviation | The state or province to be used for the ultimate destination address | yes |
| shippingAddress.city | The city to be used for the ship-to address | yes |
| shippingAddress.address1 | The first address to be used for the ship-to address | yes |
| shippingAddress.address2 | The second address to be used for the ship-to address | yes |
| shippingAddress.zipPostalCode | The postal code to be used for the ship-to address | yes |
| shippingAddress.phoneNumber | The phone number to be used for the ship-to address | yes |
| billingAddress | The billing address for the order | yes |
| billingAddress.firstName | The first name to be used for the bill-to address | yes |
| billingAddress.lastName | The last name to be used for the bill-to address | yes |
| billingAddress.company | The company name to be used for the bill-to address | yes |
| billingAddress.countryTwoletterISOCode | The two character country code to be used for the bill-to address (e.g. US) | yes |
| billingAddress.stateProvinceAbbreviation | The state or province to be used for the ultimate destination address | yes |
| billingAddress.city | The city to be used for the bill-to address | yes |
| billingAddress.address1 | The first address to be used for the bill-to address | yes |
| billingAddress.address2 | The second address to be used for the bill-to address | yes |
| billingAddress.zipPostalCode | The postal code to be used for the bill-to address | yes |
| billingAddress.phoneNumber | The phone number to be used for the bill-to address | yes |
| paymentMethod | The payment method to pay for the order | yes |
|
CustomerPoNumber
|
no | |
| orderComment | Comment of the currently selected order | No |
| orderItem | yes | |
| orderItem.productId | The unique identifier for the order line item | yes |
| orderItem.partNumber | No | |
| orderItem.manufacturerName | No | |
| orderItem.quantity | The number of items purchased | yes |
| orderItem.price | Item unit price | No |
| orderItem.customerpartnumber | Customer Part Number | No |
| currencycode | Currency Code | No |
Example Request onlinecomponents.com
{
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"shippingMethod": "string",
"accountNo": "string",
"carrier": "string",
"shippingInsurance": true,
"taxable": true,
"resaleNumber": false,
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"countryTwoletterISOCode": "string",
"stateProvinceAbbreviation": "string",
"city": "string",
"address1": "string",
"address2": "string",
"zipPostalCode": "string",
"phoneNumber": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"countryTwoletterISOCode": "string",
"stateProvinceAbbreviation": "string",
"city": "string",
"address1": "string",
"address2": "string",
"zipPostalCode": "string",
"phoneNumber": "string"
},
"paymentMethod": "string",
"customerponumber": "string",
"orderComment": "string",
"orderItem": [{
"productId": 0,
"partNumber": "string",
"manufacturerName": "string",
"quantity": 0,
"price": 0,
"customerpartnumber": "string"
}],
"currencycode": "string",
}
Example Response onlinecomponents.com
{
"orderId": "string",
"errors": [
"string"
],
"success": true
}
Available Shipping Methods
Domestic Options
| Agent Code | Service Code |
|---|---|
| UPS | UPS Ground |
| UPS | UPS 3rd Day |
| UPS | UPS 2nd Day |
| UPS | UPS Next Day Saver |
| UPS | UPS Next Day |
| UPS | UPS Next Day Early |
| FEDEX | FedEx Ground |
| FEDEX | FedEx 3rd Day |
| FEDEX | FedEx 2nd Day |
| FEDEX | FedEx Priority Overnight |
| FEDEX | FedEx Std Overnight |
International Options
| Agent Code | Service Code |
|---|---|
| UPS | UPS World Wide Express |
| UPS | UPS World Wide Saver |
| UPS | UPS World Wide Expedited |
| FEDEX | FedEx International Priority |
| FEDEX | FedEx International Economy |
Available Payment Methods
| Payment Method Name |
|---|
| Net30 |
| Net45 |
| Net60 |
| PrePayment |
| Net15 |
| Net75 |
| Net90 |
Available Currency
| Currency | Currency Code |
|---|---|
| USD | usd |
| EUR | eur |
Potential Error Messages
The following is a list of error messages that could be received as a result of an error in the API request or one of the onlinecomponents.com internal prerequisites not being completed.
| Description |
|---|
| The minimum quantity allowed for purchase is |
| The maximum quantity allowed for purchase is |
| Allowed quantities for this product: |
| You may purchase all in-stock quantity of {0} or our minimum order quantity of {1} . Please adjust your quantity and add to cart to continue. |
| Quantity should be increments of |
| Minimum order quantity is |
| Please insert valid quantity |
| MOQ for out of Stock Qty is |
| Sorry, Item has no price, please contact us or submit price request |
| Sorry, Can not change quantity for this item |
| Sorry, we have limited Availability, please contact us or submit price request |
| Email is required |
| First Name is required |
| Last Name is required |
| Phone Number is required |
| Country Two letter ISO Code is required |
| Company is required |
| Address1 is required |
| City is required |
| Zip Postal Code is required |
| Please add valid data for item |
| Order Item is required |
| ShippingMethod is required |
| AccountNo is required |
| ship account should be 6 characters |
| ship account should be 9 characters |
| No Customer Found |
| no shipping address found |
| Shipping Address Error |
| Shipping Method Error |
| Error on Process Order |
| Payment Error |
| This product is no longer available, please modify your shopping cart |
Order History API
造訪 Onlinecomponents.com 結帳流程並在您自己的應用程式中訂購零件。
描述
訂單 API 可用於從 Onlinecomponents.com 下訂單和檢查訂單。 我們有一個更快、更靈活的新版本 Order API:
- JSON 透過更清晰的回應資料提供更快的處理速度
- 資料格式更清晰,更容易在現代瀏覽器中顯示
- API 版本控制:請求和回應可以採用 JSON 或 XML 格式
端點
訂單 API 可用於從 Onlinecomponents.com 下訂單和檢查訂單。