Bắt đầu thi công
1. Thông tin chung
Các Service của MeInvoice đều là RESTful Web Services có thuộc tính như sau:
Tên | BaseUrl | |
---|---|---|
Mô tả | Link cho các đầu API | |
Môi trường test | https://testapi.meinvoice.vn/api/integration/invoice | |
Môi trường chính thức | https://api.meinvoice.vn/api/integration/invoice |
Tất cả các Request gọi lên hệ thống MeInvoice đều phải chứa thông tin Authorization trong Header(trừ api get token) như sau:
GET/POST: <url>
Headers:
Content-Type: application-json
Authorization: Bearer <token>
Trong đó đa số các service, kết quả trả về sẽ là 1 chuỗi JSON có định dạng như sau:
{
"success": <true/false>,
"errorCode": <null/Mã lỗi>,
"descriptionErrorCode": <null/Mô tả mã lỗi>,
"errors": [],
"data": "<List dữ liệu trả về>",
"customData": "<List dữ liệu liên quan trả về>"
}
Trong đó:
- Data: Là kết quả trả về của việc thực hiện yêu cầu. Trong các phần mô tả service phía dưới, khi nhắc đến Respose sẽ chính là dữ liệu trong thuộc tính này
- ErrorCode: Mã lỗi trả về trong trường hợp gọi Service lỗi. Bảng mã lỗi được mô tả ở từng service và ở cuối tài liệu này
2. Mô tả chức năng các đầu API
Tên Danh mục | Chức năng | |
---|---|---|
Lấy token Authorization | Chức năng này cung cấp cách thức lấy mã thông báo (token) để xác thực và ủy quyền truy cập vào các API của MISA. Nhà phát triển cần cung cấp thông tin đăng nhập hợp lệ để nhận token, token này sẽ được dùng cho các yêu cầu API khác trong hệ thống. | |
Lấy danh sách mẫu HĐ/Vé | Chức năng này cho phép lấy danh sách các mẫu hóa đơn (HĐ) hoặc vé điện tử có sẵn trên hệ thống MISA. Nhà phát triển có thể lựa chọn mẫu phù hợp để phát hành, đảm bảo hóa đơn/vé tuân thủ định dạng quy định của pháp luật. | |
Xem HĐ/Vé trước phát hành | Chức năng này cho phép xem trước hóa đơn hoặc vé điện tử trước khi phát hành chính thức. Nhà phát triển có thể kiểm tra và xác nhận thông tin để đảm bảo rằng dữ liệu trên hóa đơn/vé là chính xác và đầy đủ trước khi gửi đi. | |
Phát hành HĐ/Vé | Chức năng này thực hiện việc phát hành chính thức hóa đơn hoặc vé điện tử. Sau khi phát hành, hóa đơn/vé sẽ được lưu trữ trên hệ thống MISA và có hiệu lực pháp lý, đồng thời được gửi đến cơ quan thuế. Có thể gửi đến khách hàng qua email sau khi phát hành thành công | |
Xem HĐ/Vé sau phát hành | Sau khi phát hành, nhà phát triển có thể sử dụng chức năng này để xem lại chi tiết hóa đơn hoặc vé điện tử. Đây là bản chính thức được hệ thống MISA xác nhận, có thể sử dụng để đối chiếu hoặc cung cấp cho khách hàng. | |
Tải HĐ/Vé sau phát hành | Chức năng này cho phép tải về bản sao hóa đơn hoặc vé điện tử đã phát hành dưới định dạng chuẩn (PDF hoặc XML). Bản tải về có thể được lưu trữ, chia sẻ hoặc gửi cho khách hàng khi cần thiết. | |
Gửi email HĐ/Vé cho KH | Sau khi hóa đơn/vé được phát hành, chức năng này hỗ trợ việc gửi trực tiếp hóa đơn hoặc vé qua email đến khách hàng. Nhà phát triển cần cung cấp thông tin email khách hàng. | |
Lấy trạng thái HĐ/Vé | Chức năng này cho phép kiểm tra trạng thái hiện tại của hóa đơn hoặc vé điện tử, ví dụ như đã phát hành, đã gửi cho khách hàng, hoặc bị hủy. Điều này giúp nhà phát triển theo dõi quy trình xử lý hóa đơn và thông tin cần thiết trong các tình huống khác nhau. |