API Công ty
Tài liệu về cách sử dụng API công ty thông qua OAuth2 trong SePay.
Giới thiệu
API công ty của SePay cho phép bạn truy cập thông tin về công ty hiện tại và cấu hình của công ty. API này chỉ dành cho người dùng có vai trò Admin hoặc SuperAdmin trong công ty.
Để sử dụng API này, bạn cần có quyền
companytrong phạm vi (scope) của Access Token và phải là người dùng với vai trò Admin hoặc SuperAdmin.
Các Endpoints
API công ty cung cấp các endpoints sau:
GET/api/v1/company- Lấy thông tin của công ty hiện tại
PATCH/api/v1/company/configurations- Cập nhật cấu hình công ty
Lấy thông tin công ty
GET
/api/v1/companyAuthorization: Bearer {YOUR_ACCESS_TOKEN}
- Endpoint này trả về thông tin của công ty hiện tại và các cấu hình liên quan.
- Quyền yêu cầu
- Scope:
company - Vai trò người dùng:
AdminhoặcSuperAdmin
- Scope:
Cập nhật cấu hình công ty
PATCH
/api/v1/company/configurationsAuthorization: Bearer {YOUR_ACCESS_TOKEN}
- Endpoint này cho phép cập nhật cấu hình của công ty, đặc biệt là cấu trúc mã thanh toán.
- Quyền yêu cầu
- Scope:
company - Vai trò người dùng:
AdminhoặcSuperAdmin
- Scope:
| Tên | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
payment_code_formats | array | Bắt buộc | Danh sách các định dạng mã thanh toán (bắt buộc nếu được gửi) |
Mã lỗi
- Dưới đây là các mã lỗi có thể gặp khi sử dụng API công ty:
| Mã HTTP | Mô tả | Nguyên nhân |
|---|---|---|
| 401 | Unauthorized Access token không hợp lệ hoặc đã hết hạn | — |
| 403 | Forbidden Không đủ quyền truy cập (không phải Admin hoặc SuperAdmin) | — |
| 400 | Bad Request Dữ liệu gửi lên không hợp lệ (không đáp ứng các ràng buộc) | — |
| 500 | Internal Server Error Lỗi máy chủ khi xử lý yêu cầu | — |