ภาพรวม NEXTSHIP API
NEXTSHIP API คือ บริการ API สำหรับดึงข้อมูลจากเว็บไซต์ E-Commerce ของจีน อาทิ 1688, Taobao/Tmall, Alibaba โดย NEXTSHIP API เหมาะสำหรับ นักพัฒนา หรือ ผู้ประกอบการที่ต้องการพัฒนาระบบสำหรับธุรกิจด้านนำเข้าสินค้าจากประเทศจีน หากสนใจบริการสามารถติดต่อเพื่อขอทดลอง API ดึงสินค้าจีนได้เลยครับ
API สินค้าจีนทำงานอย่างไร ?
*การใช้งาน API จำเป็นต้องติดต่อขอ Token เพื่อใช้งาน API ก่อน หลังจากได้รับ Token แล้วสามารถเริ่มทดลองใช้งานได้เลยครับ
API สินค้าจีนจะทำงานระหว่าง Server NEXTSHIP และ Server client ของท่านโดย Request จะถูกส่งผ่าน HTTPS ในรูปแบบ JSON โดยแนะนำให้ใช้ Backend ของท่าน Request ไปที่ Server NEXTSHIP โดยมีรายละเอียดดังนี้
- Front-end ของท่าน ทำการ Request ไปที่ Server Back-end ของท่านผ่านทาง Ajax หรือ Server side render
- Back-end ของท่าน ทำการ Request ไปที่ Server NEXTSHIP โดย Server จะตอบกลับในรูปแบบ JSON
- นำ Response ที่ได้จาก NEXTSHIP ส่งกลับไปให้ Front-end เพื่อทำการแสดงข้อมูลสินค้า
*ไม่แนะนำให้ใช้ Front end ของท่านเพื่อเชื่อมต่อไป Server NEXTSHIP โดยตรง (นำข้อ 1 เชื่อมต่อไปที่ข้อ 3 โดยตรง) เพื่อป้องกัน API Key ที่อาจจะถูกอ่านหรือขโมยจากฝั่ง Front end ได้
Rate Limit
API ของทาง NEXTSHIP มีระบบ Rate Limit คือ การจำกัดการ Request ข้อมูลต่อนาทีเพื่อความเสถียรต่อระบบ และผู้ใช้งานท่านอื่น โดยมีการจำกัดที่ 300 request ต่อ 1 นาที (300 req/m)
หากคุณส่ง Request เกินอัตราที่กำหนด คุณจะได้รับข้อความแสดงข้อผิดพลาดว่า 429 Too Many Requests หากได้รับข้อผิดพลาดดังกล่าวกรุณาลองอีกครั้งภายหลัง 1 นาที
Status Codes
รหัสสถานะ HTTP เหล่านี้จะถูก Response หลังจากการเรียก API เราปฏิบัติตาม ข้อกำหนดรหัสสถานะ HTTP เว้นแต่จะระบุไว้เป็นอย่างอื่น
| Status code | Description |
|---|---|
| 200 OK | Request successful. (คำขอสำเร็จ) |
| 400 Bad Request | Problem with the request. (มีปัญหาเกี่ยวกับการ Request) |
| 401 Unauthorized | Token unauthorized or expire. (Token ไม่ถูกต้อง หรือ package api หมดอายุ) |
| 404 Not Found | Item or product not found. (ไม่พบข้อมูลที่ Request เช่น Endpoint ไม่ถูกต้อง หรือ ไม่พบสินค้านี้) |
| 413 Payload Too Large | Request exceeds the max size of 2MB. Make the request smaller than 2MB and try again. (Request มีขนาดใหญ่เกิน 2 MB) |
| 422 Unprocessable Entity | The given data was invalid. (Parameters ที่ส่งมาผิดพลาด หรือ ไม่ตรงกับที่ Endpoint นั้นต้องการ) |
| 429 Too Many Requests | Exceeded the rate limit for requests. (Request ติด Rate Limit ให้ลองใหม่ภายหลัง) |
| 500 Internal Server Error | Error on the internal server. (Server เกิดข้อผิดพลาด 500 กรุณาติดต่อผู้ดูแล) |
Request headers
Header Parameters สำหรับเรียกใช้งาน API สินค้าจีน หากไม่ได้ส่ง Header มากับ Request ระบบจะ Reject Request ทันทีโดย Response status code 400 หรือ 401
| Header | Type | Required | Value/Example |
|---|---|---|---|
| Accept | String | Yes | application/json |
| Content-Type | String | Yes | application/json |
| Authorization | String | Yes | Bearer {TOKEN} ตัวอย่าง Bearer AIWJhiahwTIJFJAGXKS2 |
