Начало работы
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
Добавить новый филиал
Тестовая среда (Sandbox)
Мы понимаем важность тестирования перед запуском. Поэтому мы предоставляем полностью функциональную среду sandbox, где вы можете экспериментировать со всеми нашими API, не затрагивая производственные данные.
Доступ к Sandbox
- Запрос ключа API Sandbox
- Другой базовый 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.
Параметры запроса
| Параметр | Описание | Обязательный |
|---|---|---|
| Электронная почта | да | |
| firstName | Имя | да |
| lastName | Фамилия | да |
| phoneNumber | Номер телефона | да |
| shippingMethod | да | |
| accountNo | Номер учетной записи доставки | да |
| carrier | Нет | |
| shippingInsurance | да | |
| taxable | да | |
| resaleNumber | Нет | |
| shippingAddress | Адрес доставки | да |
| shippingAddress.firstName | Имя | да |
| shippingAddress.lastName | Фамилия | да |
| shippingAddress.company | компания | да |
| shippingAddress.countryTwoletterISOCode | страна | да |
| shippingAddress.stateProvinceAbbreviation | государство | да |
| shippingAddress.city | Сити | да |
| shippingAddress.address1 | Адрес 1 | да |
| shippingAddress.address2 | Адрес 2 | да |
| shippingAddress.zipPostalCode | ZIP / почтовый индекс | да |
| shippingAddress.phoneNumber | Номер телефона | да |
| billingAddress | 4. Введите имя для своего приложения и нажмите | да |
| billingAddress.firstName | Имя | да |
| billingAddress.lastName | Фамилия | да |
| billingAddress.company | компания | да |
| billingAddress.countryTwoletterISOCode | страна | да |
| billingAddress.stateProvinceAbbreviation | государство | да |
| billingAddress.city | Сити | да |
| billingAddress.address1 | Адрес 1 | да |
| billingAddress.address2 | Адрес 2 | да |
| billingAddress.zipPostalCode | ZIP / почтовый индекс | да |
| billingAddress.phoneNumber | Номер телефона | да |
| paymentMethod | Способ оплаты | да |
|
CustomerPoNumber
|
no | |
| orderComment | Комментарий к заказу | Нет |
| orderItem | да | |
| orderItem.productId | Идентификатор позиции заказа | да |
| orderItem.partNumber | Нет | |
| orderItem.manufacturerName | Нет | |
| orderItem.quantity | Кол-во | да |
| orderItem.price | цена | Нет |
| orderItem.customerpartnumber | Номер детали клиента | Нет |
| currencycode | Код валюты | Нет |
Пример запроса
{
"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",
}
Пример ответа
{
"orderId": "string",
"errors": [
"string"
],
"success": true
}
Доступные способы доставки
Внутренние варианты
| Код перевозчика | Код услуги |
|---|---|
| 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 |
Международные варианты
| Код перевозчика | Код услуги |
|---|---|
| UPS | UPS World Wide Express |
| UPS | UPS World Wide Saver |
| UPS | UPS World Wide Expedited |
| FEDEX | FedEx International Priority |
| FEDEX | FedEx International Economy |
Доступные способы оплаты
| Название способа оплаты |
|---|
| Net30 |
| Net45 |
| Net60 |
| PrePayment |
| Net15 |
| Net75 |
| Net90 |
Доступные валюты
| Валюта | Код валюты |
|---|---|
| USD | usd |
| EUR | eur |
Возможные сообщения об ошибках
Ниже перечислены сообщения об ошибках, которые могут быть возвращены из-за ошибки в запросе API или невыполненного внутреннего условия.
| Описание |
|---|
| 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 |
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.