Chuyển tới nội dung chính

Hướng dẫn cấu hình

Chào mừng bạn đến với tài liệu API của Simplize. Trang này sẽ cung cấp cái nhìn tổng quan về các khái niệm cơ bản bạn cần biết để bắt đầu sử dụng và tích hợp các dịch vụ API của chúng tôi.

1. Môi trường API​

Simplize cung cấp các môi trường API riêng biệt cho mục đích phát triển/thử nghiệm và production. Điều này giúp bạn phát triển và kiểm thử mà không ảnh hưởng đến dữ liệu production.

Môi trườngURL cơ sở (Base URL)Mục đích
Developmenthttps://api.simplize.devĐể phát triển và thử nghiệm các tính năng mới.
Productionhttps://api2.simplize.vnĐể sử dụng trong các ứng dụng thực tế.

Lưu ý: Vui lòng sử dụng URL phù hợp với môi trường bạn đang làm việc. Trong trình mô phỏng API của chúng tôi, bạn có thể thay đổi trường Base URL.

2. Xác Thực API​

Tất cả các cuộc gọi API của Simplize yêu cầu xác thực để đảm bảo an toàn và bảo mật dữ liệu. Chúng tôi sử dụng phương thức xác thực bằng API Key và HMAC Signature.

Bảo mật nâng cao

Đối với các endpoint yêu cầu bảo mật cao (SIGNED), bạn cần tạo chữ ký số (signature) cho mỗi request. Xem chi tiết tại Bảo mật Request.

Lấy API Key của bạn​

thông tin

Api của bạn đã được cung cấp bởi chúng tôi, nếu có vấn đề thắc mắc vui lòng liên hệ trực tiếp để giải đáp.

Cách sử dụng API Key​

API Key của bạn cần được gửi trong mỗi yêu cầu API thông qua một HTTP header có tên là X-Api-Key.

Ví dụ trong lệnh cURL:

curl -X GET "https://api.simplize.dev/api/personalize/v1/partner/screener/list" -H "X-Api-Key: YOUR_API_KEY_FROM_PORTAL"

Ví dụ trong JavaScript (sử dụng fetch):

fetch('https://api.simplize.dev/api/personalize/v1/partner/screener/list', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY_FROM_PORTAL',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

3. Mã Lỗi Phổ Biến​

Khi làm việc với API, bạn có thể nhận được các mã trạng thái HTTP (HTTP Status Codes) và thông báo lỗi. Dưới đây là một số mã lỗi phổ biến mà bạn có thể gặp:

  • 403 Forbidden: Yêu cầu đã được xác thực, nhưng bạn không có quyền truy cập vào tài nguyên đó hoặc thực hiện hành động đó.
    • API Key của bạn không có đủ quyền.
    • Tài nguyên bị giới hạn truy cập.
  • 404 Not Found: Tài nguyên được yêu cầu không tồn tại hoặc không thể tìm thấy.
    • Đường dẫn API sai.
    • ID tài nguyên không tồn tại.
  • 500 Internal Server Error: Lỗi không xác định xảy ra ở phía máy chủ API.
    • Thường là lỗi không mong muốn ở backend.
    • Nếu gặp lỗi này, hãy liên hệ đội ngũ hỗ trợ của Simplize với thông tin chi tiết về yêu cầu của bạn.

Chi tiết các mã lỗi vui lòng truy cập danh sách mã lỗi API

4. Hỗ Trợ và Phản Hồi​

Nếu bạn có bất kỳ câu hỏi nào, cần hỗ trợ tích hợp, hoặc muốn gửi phản hồi về tài liệu API của chúng tôi, vui lòng liên hệ với đội ngũ hỗ trợ của Simplize qua:

Chúng tôi luôn sẵn lòng hỗ trợ bạn!