Tổng quan về tài liệu API
1. Nhận thông tin chi tiết về tài khoản
Điểm cuối:
LẤY https://codemarket.vn/api/account/details
Mô tả: Truy xuất thông tin chi tiết về tài khoản được liên kết với khóa API được cung cấp.
2. Nhận tất cả các mặt hàng
Điểm cuối:
LẤY https://codemarket.vn/api/items/all
Mô tả: Truy xuất tất cả các mặt hàng liên quan đến khóa API được cung cấp.
3. Nhận thông tin chi tiết về mặt hàng
Điểm cuối:
LẤY https://codemarket.vn/api/items/item
Mô tả: Truy xuất thông tin chi tiết của một mặt hàng cụ thể dựa trên ID mặt hàng và khóa API được cung cấp.
4. Xác thực mua hàng
Điểm cuối:
BÀI ĐĂNG https://codemarket.vn/api/purchases/validation
Mô tả: Xác thực mã mua hàng và trả về thông tin chi tiết về giao dịch mua nếu hợp lệ.
Xác thực
Điều hướng đến cài đặt không gian làm việc
Trước tiên, người dùng phải đăng nhập vào tài khoản của mình trên nền tảng. Sau đó, họ có thể điều hướng đến phần "Cài đặt" trong không gian làm việc của mình.
Xác định vị trí phần Khóa API
Trong phần cài đặt không gian làm việc, người dùng nên tìm phần có nhãn cụ thể là "Khóa API" hoặc "Quyền truy cập API".
Tạo hoặc lấy khóa API
Trong phần này, người dùng có thể tạo khóa API mới hoặc lấy khóa hiện có nếu đã được tạo trước đó. Nếu có tùy chọn tạo khóa mới, người dùng có thể nhấp vào tùy chọn đó để tạo khóa API mới.
Sao chép khóa API
Sau khi khóa API được tạo hoặc truy xuất, người dùng sẽ có thể thấy khóa đó hiển thị trên màn hình. Họ chỉ cần nhấp vào nút hoặc biểu tượng bên cạnh khóa để sao chép vào bảng nhớ tạm.
Sử dụng khóa API
Sau khi sao chép khóa API, người dùng giờ đây có thể sử dụng khóa này để xác thực yêu cầu khi truy cập các điểm cuối API của nền tảng. Thông thường, họ cần đưa khóa API vào tiêu đề hoặc tham số yêu cầu, tùy thuộc vào cơ chế xác thực API.
Bảo mật khóa API
Điều quan trọng là phải nhắc nhở người dùng giữ khóa API của họ an toàn và không chia sẻ công khai. Họ nên tránh mã hóa cứng khóa API trong mã phía máy khách hoặc chia sẻ chúng trên các kho lưu trữ công khai. Thay vào đó, họ nên cân nhắc lưu trữ khóa API một cách an toàn trên các ứng dụng phía máy chủ và sử dụng các biện pháp kiểm soát truy cập phù hợp.
Nhận thông tin chi tiết về tài khoản
Truy xuất thông tin chi tiết về tài khoản được liên kết với khóa API được cung cấp
Điểm cuối
LẤYhttps://codemarket.vn/api/account/details
Các thông số
- api_key: Khóa API của bạn
(Yêu cầu)
Phản hồi
Phản hồi thành công:
{
"status": "thành công",
"data": {
"name": {
"firstname": "John",
"lastname": "Doe",
"full_name": "John Doe"
},
"username": "johndoe",
"email": "john.doe@example.com",
"balance": 100.00,
"currency": "USD",
"profile": {
"heading": "Profile Heading",
"description": "Profile Description",
"contact": {
"email": "contact@example.com"
},
"social_links": [
"facebook": "/",
"x": "/",
// etc...
],
"media": {
"avatar": "https://example.com/avatar.jpg",
"cover": "https://example.com/cover.jpg"
}
},
"registered_at": "2024-04-27T12:00:00Z"
}
}
Phản hồi lỗi:
{
"status": "lỗi",
"msg": "Yêu cầu không hợp lệ"
}
Nhận tất cả các mặt hàng
Truy xuất tất cả các mặt hàng liên quan đến khóa API được cung cấp
Điểm cuối
LẤYhttps://codemarket.vn/api/items/all
Các thông số
- api_key: Khóa API của bạn
(Yêu cầu)
Phản hồi
Phản hồi thành công:
{
"status": "thành công",
"items": [
{
"id": 1,
"name": "Sample Item",
"description": "This is a sample item",
"category": "Category Name",
"sub_category": "Subcategory Name",
"options": ["option1", "option2"],
"version": 1.0.0,
"demo_link": "https://example.com/demo",
"tags": ["tag1", "tag2"],
"media": {
"thumbnail": "https://example.com/thumbnail.png",
"preview_image": "https://example.com/preview.jpg", // Điều này không bao gồm đối với các mặt hàng âm thanh
"preview_video": "https://example.com/video.mp4", // Điều này chỉ bao gồm cho các mặt hàng video
"preview_audio": "https://example.com/audio.mp3", // Điều này chỉ bao gồm cho các mặt hàng âm thanh
"screenshots": [ // Điều này chỉ được bao gồm nếu mặt hàng có ảnh chụp màn hình
"https://example.com/screenshot1.jpg",
"https://example.com/screenshot2.jpg"
],
},
"price": {
"regular": 19.99,
"extended": 29.99
},
"currency": "USD",
"published_at": "2024-04-27T12:00:00Z"
},
{
// Next item...
}
]
}
Phản hồi lỗi:
{
"status": "lỗi",
"msg": "Không tìm thấy mặt hàng nào"
}
Nhận thông tin chi tiết về mặt hàng
Truy xuất thông tin chi tiết của một mặt hàng cụ thể dựa trên ID mặt hàng và khóa API được cung cấp.
Điểm cuối
LẤYhttps://codemarket.vn/api/items/item
Các thông số
- api_key: Khóa API của bạn
(Yêu cầu) - item_id: ID của mặt hàng cần lấy
(Yêu cầu)
Phản hồi
Phản hồi thành công:
{
"status": "thành công",
"item": {
"id": 1,
"name": "Sample Item",
"description": "This is a sample item",
"category": "Category Name",
"sub_category": "Subcategory Name",
"options": ["option1", "option2"],
"version": 1.0.0,
"demo_link": "https://example.com/demo",
"tags": ["tag1", "tag2"],
"media": {
"thumbnail": "https://example.com/thumbnail.png",
"preview_image": "https://example.com/preview.jpg", // Điều này không bao gồm đối với các mặt hàng âm thanh
"preview_video": "https://example.com/video.mp4", // Điều này chỉ bao gồm cho các mặt hàng video
"preview_audio": "https://example.com/audio.mp3", // Điều này chỉ bao gồm cho các mặt hàng âm thanh
"screenshots": [ // Điều này chỉ được bao gồm nếu mặt hàng có ảnh chụp màn hình
"https://example.com/screenshot1.jpg",
"https://example.com/screenshot2.jpg"
],
},
"price": {
"regular": 19.99,
"extended": 29.99
},
"currency": "USD",
"published_at": "2024-04-27T12:00:00Z"
}
}
Phản hồi lỗi:
{
"status": "lỗi",
"msg": "Không tìm thấy mặt hàng"
}
Xác thực mua hàng
Xác thực mã mua hàng và trả về thông tin chi tiết về giao dịch mua nếu hợp lệ.
Điểm cuối
BÀI ĐĂNGhttps://codemarket.vn/api/purchases/validation
Các thông số
-
api_key: Khóa API của bạn
(Yêu cầu). -
purchase_code:
Mã mua hàng để xác thực
(Yêu cầu).
Phản hồi
Phản hồi thành công:
{
"status": "thành công",
"data": {
"purchase": {
"purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
"license_type": "Thường xuyên",
"price": 19.99,
"currency": "USD",
"item": {
"id": 1,
"name": "Sample Item",
"description": "This is a sample item",
"category": "Category Name",
"sub_category": "Subcategory Name",
"options": ["option1", "option2"],
"version": 1.0.0,
"demo_link": "https://example.com/demo",
"tags": ["tag1", "tag2"],
"media": {
"thumbnail": "https://example.com/thumbnail.png",
"preview_image": "https://example.com/preview.jpg", // Điều này không bao gồm đối với các mặt hàng âm thanh
"preview_video": "https://example.com/video.mp4", // Điều này chỉ bao gồm cho các mặt hàng video
"preview_audio": "https://example.com/audio.mp3", // Điều này chỉ bao gồm cho các mặt hàng âm thanh
"screenshots": [ Điều này chỉ được bao gồm nếu mặt hàng có ảnh chụp màn hình
"https://example.com/screenshot1.jpg",
"https://example.com/screenshot2.jpg"
],
},
"price": {
"regular": 19.99,
"extended": 29.99
},
"currency": "USD",
"published_at": "2024-04-27T12:00:00Z"
},
"supported_until": "2024-04-27T12:00:00Z", // Điều này sẽ không tồn tại nếu hỗ trợ bị vô hiệu hóa hoặc không được hỗ trợ
"downloaded": false,
"date": "2024-04-27T12:00:00Z"
}
}
}
Phản hồi lỗi:
{
"status": "lỗi",
"msg": "Mã mua hàng không hợp lệ"
}