API Key

Sử dụng API Key để xác thực khi kết nối với API. API Key không hết hạn.

Cách lấy API Key

Để sử dụng các API, bạn cần lấy API Key từ OVIRO. Bạn có thể tạo nhiều API Key cho các kết nối khác nhau. Theo hướng dẫn sau:

1. Vào trang quản trị
2. Chọn "Cửa hàng" -> "Cài đặt khác" -> Chọn tab "API" và click vào "Tới trang cài đặt API"
3. Khi đang ở trang danh sách API Key, click vào "Thêm"
4. Nhập Tên, Mô tả và chọn loại là "Private API"
5. Click vào "Lưu thông tin" sẽ tạo thành công và trở về danh sách API Key
6. Ở danh sách API Key, tìm API Key mới vừa tạo và nhấn nút "Sửa" để lấy API Key và API Secret.

Cách kết nối dùng API Key

• Web Service của OVIRO sử dụng cơ chế xác thực thông qua header dựa trên API Key và API Secret.
• Tất cả các request lên server cần cung cấp thêm Header có tên là "Authorization" và có giá trị theo định dạng "apikey:apisecret". Ví dụ nếu API Key của bạn là "123" và API Secret của bạn là "abc" thì các request của bạn gửi lên server phải có thêm header "Authorization" có giá trị là "123:abc". (Không có Basic hay base64 encode)
• Luôn truyền thêm company_id và creator_id trong request param (GET) hoặc body payload (POST, PUT, DELETE) để xác định công ty và người tạo/người thực hiện action.
• Để biết user_id của một nhân viên, vào phần cập nhật thông tin nhân viên, sẽ có thông tin User ID của một nhân viên. User ID sẽ khác với Employee ID.
• Để biết company_id của một công ty, vào phần thông tin công ty ở menu Profile, sẽ có thông tin Company ID của một công ty.