LCSC API Instruction

LCSC API Instruction is mainly for LCSC partners who wish to use our API service to integrate our system with yours. If you have any questions, please send email to support@LCSC.COM.

LCSC API

Introduction

LCSC provides eight API services that allow customers and partners to automate some of the tasks that can be performed on LCSC.COM

Getting Started

Before using the API service, you will need to complete the following steps:

Create an account at LCSC.COM
Summit applied material including company website, business license (or certificate equivalent to business license), contact information, estimated order quantity, cooperation mode etc.
Apply an API key at LCSC via support@lcsc.com

Request Validation

All requests must involve three parameters to verify whether the request is valid or not:

Parameter	Description
key	Apply an user ID at LCSC.COM
nonce	Random
timestamp	The timestamp of the request
signature	Signature

Note: Secret cannot be placed in request parameters

Signature verification

LCSC API will verify the request to ensure the security of data.

The signature verification algorithm involves the API key name key, the API secret name secret, the request timestamp name timestamp and a 16-bit random string name nonce.
When request LCSC API, a signature should be sent. Example:

signature =sha1(key=xxx&nonce=xxx&secret=xxxx&timestamp=xxx)

When LCSC API server gets the request, the signature will be verified as the same algorithm. If the signature is not right, the request will be refused.
If the timestamp is over 60s, the request will be refused.

An example, the data verification for LCSC API

The API key:


key=7dc6035da7874b5b9bc245bd28017290

The API secret:


xxxxxxxxxx
secret=eiru73y343r36fdi

The request timestamp:


xxxxxxxxxx
timestamp=1524662065

The 16-bit random string:


xxxxxxxxxx
nonce=63yeike7dy6c2kjd

Therefore, the string used for the signature is:


xxxxxxxxxx
key=7dc6035da7874b5b9bc245bd28017290&nonce=63yeike7dy6c2kjd&secret=eiru73y343r36fdi&timestamp=1524662065

The result obtained using sha1 is:


xxxxxxxxxx
5960caf5c9675e9b4cad58ef46bf722b5413e9fa

Response Error Code Description

Code	Description
412	Date Is Required.
413	Not Found This Category.
414	Email can't find user information.
415	User address error.
416	order failed, pros params error: Not json Or malformed
417	order failed, product params error: Pro or Qty is empty
418	order failed, Optional express type is empty.
419	order failed, The configured express type is invalid.
420	order failed, The Qty must be between 1 and 1 billion.
421	No support pay method.
422	Auto pay error.
423	Dealer does not exist.
424	Key Is Required .
425	nonce Is Required .
426	timestamp Is Required .
427	signature Is Required .
428	Timestamp expired.
429	Not Found This Product.
430	Appsecret failed verification.
431	No access to information.
432	No permission.
433	Incorrect currency.
434	check orders exceed the limit, 10 at most and 1 at least.
435	Please check your participation.
436	Outside Chinese Mainland address is not support paid by RMB.
437	API request rate limit exceeded.Retry after 1 minute.
438	API request rate limit exceeded.Retry after 1 day.

Response Data Format

All of the API services response as the following format. No repetitive description in specific API.


xxxxxxxxxx
{
    "success": true,
    "code": 200,
    "message": "",
    "result": {}
}

JSON Element	Description
success	Successful call value is "true" and unsuccessful one is "false"
code	Status code
message	Error message
key	The user ID applied at LCSC.COM
result	Result of response

API Terms of Use

By using the LCSC APIs, you agree the Return Policy (https://support.lcsc.com/article/20-return), and Terms of Use as follows:

You will not use the LCSC APIs for purposes of bulk data capture
You will not host or provide to any third party any material retrieved via the LCSC APIs (including datasheets or images)
You will not sell the information, nor any derivative data, retrieved from the LCSC APIs
You will not share your uuid & apikey outside of your company and, to the extent that a uuid & apikey is specific to you individually, you will not share it with any other person
You will not assign or transfer your uuid & apikey and/or LCSC SSO credentials under any circumstances
You will not aggregate the data from the LCSC APIs into other publicly-facing/commercial APIs or data services
You will identify LCSC as the source of any information derived from the LCSC APIs
You will not share any technical aspects or documentation of the APIs with any 3rd party and you will not reverse engineer or attempt to extract the source code from any API or any related software
You will not threaten the integrity, performance or reliability of the APIs, including but not limited to performance/stress tests, or in any manner that attempts to destabilize the security of the APIs
LCSC may use your company or product name in the promotion of LCSC APIs You will comply with any and all applicable laws and regulations
LCSC reserves the right to modify these terms at any time
LCSC reserves all the right for the final explanation.

Failure to comply may result in revocation of access and any other remedy available at law or in equity.