Unlock Icon Desbloqueie descontos exclusivos! Faça login ou registre-se agora para ter acesso a melhores preços.
help desk software

Começando

Bem-vindo ao Onlinecomponents.com API Suite! Siga estes passos para começar:

Autenticação

Para acessar as APIs do Onlinecomponents.com, você precisará de uma chave de API. Você pode obter chaves de API de produção e sandbox no mesmo local:

  1. Navegue até o seu perfil de cliente
  2. Entre na sua conta Onlinecomponents.com e vá para o seu perfil de cliente

  3. Vá para Acesso e Serviços de API
  4. No perfil do cliente, localize a seção denominada "Acesso e serviços de API". Você também pode clicar diretamente aqui para acessar a página Acesso e serviços de API

  5. Solicite sua chave de API
  6. Solicite uma chave de API nesta seção, escolhendo entre uma chave de API de produção ou sandbox. Você receberá sua chave instantaneamente. Se você suspeitar de algum problema de segurança, você pode reativar e regenerar sua chave a qualquer momento


Ambiente Sandbox

Entendemos a importância de testar antes de ir ao ar. É por isso que fornecemos um ambiente sandbox totalmente funcional, onde você pode experimentar todas as nossas APIs sem afetar seus dados de produção.

Acessando o Sandbox

  1. Solicitando uma chave de API do Sandbox
  2. Solicite sua Sandbox API Key na página API Access and Services. Essa chave é distinta da sua chave de produção e é usada exclusivamente para testes de sandbox.

  3. URL base diferente
  4. Embora os pontos de extremidade da API permaneçam os mesmos, o ambiente sandbox usa uma URL base diferente.

    1. https://api.onlinecomponents.com
    2. https://sandbox.onlinecomponents.com
  5. Portal do desenvolvedor Sandbox
  6. Acesse o ambiente sandbox através do Sandbox Developer Portal. Aqui, você encontrará toda a documentação, ferramentas e suporte necessários para ajudar você a testar sua integração de forma eficaz

API de pesquisa

A API de pesquisa do Onlinecomponents.com é uma maneira poderosa, mas fácil, de obter acesso e utilizar dados, disponibilidade e preços de produtos do Onlinecomponents.com em seus próprios aplicativos

Descrição

O serviço Search API permite que os clientes utilizem dados de produtos, disponibilidade e preços do Onlinecomponents.com em seus próprios aplicativos. Pesquise mais de 8 milhões de produtos e informações detalhadas sobre produtos com facilidade. O JSON Data Format agora está disponível para o Onlinecomponents.com Search API

    Temos uma nova versão da API de pesquisa que é mais rápida e flexível:
  • JSON oferece processamento mais rápido com dados de resposta mais limpos
  • A formatação de dados é mais limpa e fácil de exibir em navegadores modernos
  • Controle de versão da API: solicitações e respostas estão disponíveis em JSON ou XML

Características

  • Acesso instantâneo
  • Método de pesquisa por palavra-chave
  • Método de busca por número de peça
  • Até 50 resultados retornados por chamada
  • Até 100 chamadas por minuto
  • Até 100.000 chamadas por dia

Dados disponíveis

  • Product Id
  • Part Number
  • Manufacturer Name
  • Description
  • Datasheet Url
  • Part Image
  • Product Url
  • Part Image
  • Quantity Available
  • quantityAvailableTxt
  • On Order Quantity
  • Factory Stock Quantity
  • Factory Lead Time
  • isDuplicateStock
  • 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
  • HBR
  • Available less than min
  • Alternative Parts
  • Prices

Pontos finais

API de pedidos

Tenha acesso ao processo de checkout do Onlinecomponents.com e encomende peças dentro dos seus próprios aplicativos.

Descrição

A Order API pode ser usada para fazer e verificar pedidos do Onlinecomponents.com. Ela deve ser usada em conjunto com a Pricing and Availability API. Temos uma nova versão da Order API que é mais rápida e flexível:

  • JSON oferece processamento mais rápido com dados de resposta mais limpos
  • A formatação de dados é mais limpa e fácil de exibir em navegadores modernos
  • Controle de versão da API: solicitações e respostas estão disponíveis em JSON ou XML

Pontos finais

A API de pedidos pode ser usada para fazer e verificar pedidos do Onlinecomponents.com. Ela deve ser usada em conjunto com a API de preços e disponibilidade.

Request Parameters

Parameter Description Required
email 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

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"
    }]
}

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

 

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

Tenha acesso ao processo de checkout do Onlinecomponents.com e encomende peças dentro dos seus próprios aplicativos.

Descrição

A Order API pode ser usada para fazer e verificar pedidos do Onlinecomponents.com. Ela deve ser usada em conjunto com a Pricing and Availability API. Temos uma nova versão da Order API que é mais rápida e flexível:

  • JSON oferece processamento mais rápido com dados de resposta mais limpos
  • A formatação de dados é mais limpa e fácil de exibir em navegadores modernos
  • Controle de versão da API: solicitações e respostas estão disponíveis em JSON ou XML

Pontos finais

A API de pedidos pode ser usada para fazer e verificar pedidos do Onlinecomponents.com. Ela deve ser usada em conjunto com a API de preços e disponibilidade.