Erste Schritte
Willkommen bei der Onlinecomponents.com API Suite! Befolgen Sie diese Schritte, um loszulegen:
Authentifizierung
Um auf die APIs von Onlinecomponents.com zuzugreifen, benötigen Sie einen API-Schlüssel. Sie können sowohl Produktions- als auch Sandbox-API-Schlüssel vom selben Ort erhalten:
- Navigieren Sie zu Ihrem Kundenprofil
- Gehe zu API-Zugriff und -Dienste
- Fordern Sie Ihren API-Schlüssel an
Melden Sie sich bei Ihrem Onlinecomponents.com-Konto an und gehen Sie zu Ihrem Kundenprofil
Suchen Sie unter dem Kundenprofil nach dem Abschnitt „API-Zugriff und -Dienste“. Sie können auch direkt hier klicken, um auf die Seite „API-Zugriff und -Dienste“ zuzugreifen.
Fordern Sie in diesem Abschnitt einen API-Schlüssel an. Wählen Sie zwischen einem Produktions- oder einem Sandbox-API-Schlüssel. Sie erhalten Ihren Schlüssel sofort. Wenn Sie Sicherheitsprobleme vermuten, können Sie Ihren Schlüssel jederzeit erneut auslösen und neu generieren.
Sandbox-Umgebung
Wir wissen, wie wichtig Tests vor dem Live-Einsatz sind. Deshalb bieten wir eine voll funktionsfähige Sandbox-Umgebung, in der Sie mit all unseren APIs experimentieren können, ohne Ihre Produktionsdaten zu beeinträchtigen.
Zugriff auf die Sandbox
- Anfordern eines Sandbox-API-Schlüssels
- Andere Basis-URL
- https://api.onlinecomponents.com
- https://sandbox.onlinecomponents.com
- Sandbox-Entwicklerportal
Fordern Sie Ihren Sandbox-API-Schlüssel auf der Seite „API-Zugriff und -Dienste“ an. Dieser Schlüssel unterscheidet sich von Ihrem Produktionsschlüssel und wird ausschließlich für Sandbox-Tests verwendet.
Während die API-Endpunkte gleich bleiben, verwendet die Sandbox-Umgebung eine andere Basis-URL.
Greifen Sie über das Sandbox Developer Portal auf die Sandbox-Umgebung zu. Hier finden Sie alle erforderlichen Dokumente, Tools und Support, damit Sie Ihre Integration effektiv testen können.
Such-API
Die Onlinecomponents.com Search API ist eine leistungsstarke und dennoch einfache Möglichkeit, auf Produktdaten, Verfügbarkeit und Preise von Onlinecomponents.com zuzugreifen und diese in Ihren eigenen Anwendungen zu nutzen.
Beschreibung
Mit dem Search API-Dienst können Kunden Produktdaten, Verfügbarkeit und Preise von Onlinecomponents.com in ihren eigenen Anwendungen nutzen. Durchsuchen Sie mühelos über 8 Millionen Produkte und detaillierte Produktinformationen. Das JSON-Datenformat ist jetzt für die Onlinecomponents.com Search API verfügbar.
-
Wir haben eine neue Version der Search API, die schneller und flexibler ist:
- JSON bietet eine schnellere Verarbeitung mit saubereren Antwortdaten
- Die Datenformatierung ist sauberer und in modernen Browsern einfacher anzuzeigen
- API-Versionskontrolle: Anfragen und Antworten sind entweder in JSON oder XML verfügbar
Merkmale
- Sofortiger Zugriff
- Suche nach Stichwortmethode
- Suche nach Teilenummermethode
- Bis zu 50 Ergebnisse pro Anruf
- Bis zu 100 Anrufe pro Minute
- Bis zu 100.000 Anrufe pro Tag
Verfügbare Daten
- 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
Endpunkte
Bestell-API
Erhalten Sie Zugriff auf den Bezahlvorgang von Onlinecomponents.com und bestellen Sie Teile innerhalb Ihrer eigenen Anwendungen.
Beschreibung
Die Order API kann verwendet werden, um Bestellungen bei Onlinecomponents.com aufzugeben und zu prüfen. Sie ist für die Verwendung in Verbindung mit der Pricing and Availability API vorgesehen. Wir haben eine neue Version der Order API, die schneller und flexibler ist:
- JSON bietet eine schnellere Verarbeitung mit saubereren Antwortdaten
- Die Datenformatierung ist sauberer und in modernen Browsern einfacher anzuzeigen
- API-Versionskontrolle: Anfragen und Antworten sind entweder in JSON oder XML verfügbar
Endpunkte
Mithilfe der Bestell-API können Sie Bestellungen bei Onlinecomponents.com aufgeben und prüfen. Sie ist für die Verwendung in Verbindung mit der Preis- und Verfügbarkeits-API vorgesehen.
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
Erhalten Sie Zugriff auf den Bezahlvorgang von Onlinecomponents.com und bestellen Sie Teile innerhalb Ihrer eigenen Anwendungen.
Beschreibung
Die Order API kann verwendet werden, um Bestellungen bei Onlinecomponents.com aufzugeben und zu prüfen. Sie ist für die Verwendung in Verbindung mit der Pricing and Availability API vorgesehen. Wir haben eine neue Version der Order API, die schneller und flexibler ist:
- JSON bietet eine schnellere Verarbeitung mit saubereren Antwortdaten
- Die Datenformatierung ist sauberer und in modernen Browsern einfacher anzuzeigen
- API-Versionskontrolle: Anfragen und Antworten sind entweder in JSON oder XML verfügbar
Endpunkte
Mithilfe der Bestell-API können Sie Bestellungen bei Onlinecomponents.com aufgeben und prüfen. Sie ist für die Verwendung in Verbindung mit der Preis- und Verfügbarkeits-API vorgesehen.