시작하기
Welcome to the Online Components API Suite! Follow these steps to get started:
인증
To access the Online Components APIs, you'll need an API key. You can obtain both production and sandbox API keys from the same location:
- 고객 프로필로 이동하십시오
- API 액세스 및 서비스로 이동
- API 키 요청
Log in to your Online Components account and go to your customer profile
Under the customer profile, locate the section labeled "API Access and Services." You can also directly click here to access the API Access and Services page
새 지점 추가
샌드박스 환경
운영 환경으로 전환하기 전에 테스트하는 것이 중요하다는 점을 잘 알고 있습니다. 그래서 프로덕션 데이터에 영향을 주지 않고 모든 API를 실험할 수 있는 완전한 기능의 sandbox 환경을 제공합니다.
Sandbox 액세스
- Sandbox API 키 요청
- 다른 기본 URL
- https://api.onlinecomponents.com
- https://sandbox.onlinecomponents.com
- 샌드박스 개발자 포털
Request your Sandbox API Key from the API Access and Services page. This key is distinct from your production key and is used exclusively for sandbox testing.
API 엔드포인트는 동일하게 유지되지만 sandbox 환경은 다른 기본 URL을 사용합니다.
Access the sandbox environment through the Sandbox Developer Portal. Here, you'll find all the necessary documentation, tools, and support to help you effectively test your integration
Search API
The Onlinecomponents.com Search API is a powerful, yet easy, way to gain access to and utilise Onlinecomponents.com product data, availability and pricing in your own applications
설명
The Search API service allows customers to utilise Onlinecomponents.com product data, availability, and pricing in their own applications. Search over 8 million products and detailed product information with ease. JSON Data Format is now available for Onlinecomponents.com Search API
-
We have a new version of Search API that is faster and more flexible:
- JSON은 더 깔끔한 응답 데이터로 더 빠른 처리를 제공합니다
- 데이터 형식이 더 깔끔하고 최신 브라우저에서 표시하기 쉽습니다
- API 버전 관리: 요청과 응답은 JSON 또는 XML로 제공됩니다
특징
- 태그라인
- 키워드별 검색 방법
- Part Number로 검색 방법
- 호출당 최대 50개의 결과 반환
- 분당 최대 100회 호출
- 고객 전화#
사용 가능한 데이터
- 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
엔드포인트
주문 API
Onlinecomponents.com 결제 프로세스에 액세스하고 자체 애플리케이션 내에서 부품을 주문하세요.
설명
Order API는 Onlinecomponents.com에서 주문을 생성하고 확인하는 데 사용할 수 있습니다. Pricing and Availability API와 함께 사용하도록 설계되었습니다. 더 빠르고 유연한 새로운 버전의 Order API가 있습니다:
- JSON은 더 깔끔한 응답 데이터로 더 빠른 처리를 제공합니다
- 데이터 형식이 더 깔끔하고 최신 브라우저에서 표시하기 쉽습니다
- API 버전 관리: 요청과 응답은 JSON 또는 XML로 제공됩니다
엔드포인트
Order API는 Onlinecomponents.com에서 주문을 제출하고 확인하는 데 사용할 수 있습니다. Pricing and Availability API와 함께 사용하도록 설계되었습니다.
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 결제 프로세스에 액세스하고 자체 애플리케이션 내에서 부품을 주문하세요.
설명
Order API는 Onlinecomponents.com에서 주문을 생성하고 확인하는 데 사용할 수 있습니다. Pricing and Availability API와 함께 사용하도록 설계되었습니다. 더 빠르고 유연한 새로운 버전의 Order API가 있습니다:
- JSON은 더 깔끔한 응답 데이터로 더 빠른 처리를 제공합니다
- 데이터 형식이 더 깔끔하고 최신 브라우저에서 표시하기 쉽습니다
- API 버전 관리: 요청과 응답은 JSON 또는 XML로 제공됩니다
엔드포인트
Order API는 Onlinecomponents.com에서 주문을 제출하고 확인하는 데 사용할 수 있습니다. Pricing and Availability API와 함께 사용하도록 설계되었습니다.