Lấy widget token
Chi tiết triển khai
Ghi chú
Điền các thông tin sau, từ mẫu PRD API của bạn
Đây là "Hướng dẫn kỹ thuật" về cách sử dụng API trên thực tế
Liệt kê các endpoint và tất cả các thao tác CRUD được hỗ trợ
| Type | Value | Owner |
|---|---|---|
| API Name/Operation | Get Widget Token | @Keyi Fan |
| API Version | Version:202401 | |
| API URI ( Fixed for all APIs ) | Host: open-api.tiktokglobalshop.com | |
| Schemes: HTTPS | ||
| API Path | Path: |
- /authorization/202401/widget_token | | | API Method | [GET] | | | API Function Description | API này được dùng để lấy widget token của bạn nhằm gọi widget api. | |
Tham số chung (Phần này sẽ được tạo bởi Open platform)
Ghi chú
Các tham số chung bắt buộc cho các API
| Properties | Type | Required | Sample | Description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Mỗi app sẽ có một key riêng biệt. Vui lòng sử dụng key cụ thể được gán cho app của bạn. |
| timestamp | timestamp | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). Timestamp này được sử dụng cho tất cả các yêu cầu API. Nhà phát triển có thể dùng nó để chuyển đổi sang giờ địa phương. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | > Ghi chú: Cố gắng mô tả chi tiết |
Chữ ký được tạo bởi thuật toán gen. Khi bạn gửi yêu cầu API tới TTS, bạn phải ký chúng để TTS có thể nhận diện người gửi. | | x-tts-access-token | string | Y | aaaaa000-aaa0-aaa0-aaa0-aaaaaaaaa000 | Authorization Token, được cung cấp cho tất cả các TikTok Shop Partner Developer đủ điều kiện. Đặt nó trong header | | version | int32 | N | 1 | Phiên bản giao diện API mà bạn muốn truy cập |
Định nghĩa các trường OBJECT
Ghi chú
Đối với cột Additional clarification required | Detailed requirements:
Đối với các trường phổ biến hoặc câu hỏi thường gặp, hãy bổ sung chi tiết
Ví dụ: order_status là một thành phần quan trọng. Liên kết trở lại "Business Guide" nếu có thể
Cung cấp mẫu code cho cả request và response
Tham số request
| Properties | Type | Required | Sample | Description |
|---|---|---|---|---|
| Không có thông tin |
Mẫu truy vấn
PLAINTEXTWord Wrap
https://open-api.tiktokglobalshop.com/authorization/202401/widget_token?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Tham số response
| fields | type | Required | Sample | description | Additional clarification required | Detailed Requirements |
|---|---|---|---|---|---|
| code | string | req | 0 | Mã trạng thái thành công hoặc thất bại trả về trong response của API. | |
| message | string | req | Success | Thông báo thành công hoặc thất bại trả về trong response của API. Lý do thất bại sẽ được mô tả trong thông báo. | |
| request_id | string | req | 202203070749000101890810281E8C70B7 | Nhật ký request | |
| data | object | optional | |||
| -widget_token | object | optional | struct thông tin liên quan đến widget token | ||
| --token | string | optional | eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOjc0OTM5OTA3NTMyNTY5MDA0ODYsIkNsaWVudEtleSI6IjZhbW00dnVoNWZvMWciLCJTaG9wSURzIjpbNzQ5Mzk5MDc1MzI1NjkwMDQ4Nl0sIkV4cGlyZSI6MTcwMTA2NjAyMCwiU2VsbGVyVHlwZSI6MiwiZXhwIjoxNzAxMDY2MDIwfQ.KS15mwJ8LUC2U6Chfbmwr7PO2mGK_3wLYYaa8TM6DixdKmbG3o4kRSlCfi1a6UotpXxU0CNelLwX1G5H3sY7vw | widget token bạn dùng để gọi một widget api | |
| --expire_at | int64 | optional | 1701363599 | Timestamp hết hạn của widget token. Thường hết hạn sau 5 phút |
Mẫu response
JSONWord Wrap
{
"code": 0,
"data": {
"widget_token": [
{
"token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.
eyJVc2VySUQiOjc0OTM5OTA3NTMyNTY5MDA0ODYsIkNsaWVudEtleSI6IjZhbW00dnV
oNWZvMWciLCJTaG9wSURzIjpbNzQ5Mzk5MDc1MzI1NjkwMDQ4Nl0sIkV4cGlyZSI6MTcwMTA2
NjAyMCwiU2VsbGVyVHlwZSI6MiwiZXhwIjoxNzAxMDY2MDIwfQ.KS15mwJ8LUC2U6Chfbmwr7PO2mGK_
3wLYYaa8TM6DixdKmbG3o4kRSlCfi1a6UotpXxU0CNelLwX1G5H3sY7vw",
"expire_at": 1701363599
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
Mã lỗi
Ghi chú
Mã lỗi phải mang tính hướng dẫn: nêu rõ mã lỗi, định nghĩa nó, và đưa ra giải pháp
| Error Code | Error Message | Error Description ( in API Documentation ) | ||
|---|---|---|---|---|
| Impact Level | Potential Impact | Resolution | ||
| 98001001 | internal error | L3 | Không thể truy xuất thông tin shop được ủy quyền. SLA sẽ bị ảnh hưởng. | Lỗi hệ thống. Nếu lỗi xảy ra thường xuyên, vui lòng oncall. |
| 98001004 | Invalid param | L3 | Tham số không hợp lệ | Vui lòng kiểm tra tài liệu api |
| 13002013 | Seller does not exist | L3 | Không thể tìm thấy người bán | Trường hợp này xảy ra khi bạn dùng token sai để truy cập api này |
Kiểm thử API
Ghi chú
Mô tả cách nhà phát triển có thể kiểm thử API
Nếu bạn có thể dùng công cụ kiểm thử API, thì hãy dùng nó
Nếu bạn cần dùng Sandbox, thì hãy dùng nó
Đối với API này, bạn có thể sử dụng công cụ kiểm thử API.