Thông tin chung
Các thông tin cần thiết để tích hợp nền tảng CareSoft vào môi trường làm việc của bạn
- Domain: Là chuỗi ký tự đại diện cho một tài khoản doanh nghiệp mà khách hàng sử dụng trên nền tảng CareSoft. Ví dụ sau khi ký hợp đồng và triển khai nghiệp vụ caresoft bàn giao cho khách hàng địa chỉ đăng nhập là
https://caresoft.vn/khachhang01thì chuỗi "khachhang01" sẽ được gọi là domain trên hệ thống CareSoft. Trong các API sẽ định nghĩa phần này bằng biến{{domain}}. Domain này do CareSoft cung cấp cho mỗi khách hàng. - Api token: Là chuỗi mã bảo mật được cấu hình trên hệ thống CareSoft. Token chỉ thay đổi khi người quản trị bấm nút reset trên màn hình cấu hình. Trong các API sẽ định nghĩa phần này bằng biến
{{apiToken}}. - Host: Là địa chỉ gốc để truy cập các api. CareSoft sử dụng địa chỉ
https://api.caresoft.vn/làm địa chỉ gốc, dự phòng làhttps://api2.caresoft.vn/
Các mô tả dưới đây sẽ mặc định kèm tiền tố host ở đầu mỗi truy xuất Ví dụ: Tài liệu mô tả lấy danh sách agent sẽ ghiGET {domain}/api/v1/agents.Khi truy xuất sẽ nối chuỗi thànhhttps://api.caresoft.vn/{domain}/api/v1/agents
Để lấy API Token. Cần tài khoản Admin để đăng nhập vào tài khoản trên hệ thống CareSoft, Truy cập vào phần
Admin-->Api -->Api tokenBạn có thể khởi tạo và cập nhật bất cứ lúc nào. Lưu ý nếu thay đổi API KEY này các chương trình đang tích hợp sẽ bị mất k ết nối.
Màn hình cấu hình tạo và nhận kết quả API token trên hệ thống Caresoft
Xác thực qua access token, mỗi domain (account) sẽ được cấp 1 access token, yêu cầu tất cả các request gọi lên đều phải thêm "Authorization" header, kiểu dữ liệu yêu cầu là Json.
Các API được mô tả trong tài liệu này ngầm hiểu đã được đính kèm
Authorization và Content-Type trong header Ví dụ về set header vào request lấy danh sách chuyên viên
curl
--location 'https://api.caresoft.vn/{{domain}}/api/v1/agents' \
--header 'Authorization: Bearer {{apiToken}}' \
--header 'Content-Type: application/json'
Thử nghiệm với API danh sách khách hàng để hiểu cơ chế hoạt động của hệ thống
get
{{domain}}/api/v1
/agents
Lấy danh sách Agents
Lấy danh sách các agent của 1 domain trên hệ thống CareSoft
Parameters
Header
Authorization*
Bearer {{apiToken}}
Mã API token từ hệ thống CareSoft
Content-Type*
application/json
Kiểu dữ liệu
Responses
200: OK
Thành công
401: Unauthorized
Sai API Token hoặc không cung cấp API Token
404: Not Found
Không tìm thấy tài nguyên, Lỗi này kiểm tra lại API Url xem chính xác hay chưa
422: Unprocessable Entity
Thiếu thông tin đầu vào (một số trường hợp)
500: Internal Server Error
Lỗi chung
Ví dụ điển hình khi triệu gọi API CareSoft qua
curl: Bạn cũng có thể áp dụng để tạo Api call trên ứng dụng của bạn hoặc trên ứng dụng Postman curl
postman
Cấu hình curl với thông tin xác thực
curl
--location 'https://api.caresoft.vn/{{domain}}/api/v1/agents' \
--header 'Authorization: Bearer {{apiToken}}' \
--header 'Content-Type: application/json'
Cấu hình chèn thông tin xác thực trên postman
Lưu ý: Trong một số trường hợp thông tin yêu cầu bắt buộc được trả về trong body response. Cần kiểm tra thêm dữ liệu trả về để xử lý lỗi. Các trường hợp như vậy CareSoft sẽ mô tả rõ trong từng API chi tiết
- POSTMAN Postman là một loại công cụ cho phép người dùng có thể thao tác với API, mà trong đó phổ biến nhất là REST. Với thử nghiệm API thì Postman là một trong những công cụ phổ biến vì được thực nghiệm nhiều nhất. Nhờ Postman lập trình viên có thể gọi Rest API mà không cần phải viết bất kỳ dòng code nào. Postman có khả năng hỗ trợ mọi phương thức HTTP bao gồm: POST, PUT, DELETE, PATCH, GET,... Ngoài ra, Postman còn cho phép lập trình viên lưu lại lịch sử của các lần request nên vô cùng tiện lợi cho nhu cầu sử dụng lại. Đây là loại công cụ mã nguồn mở nên rất dễ để tải về. Bạn cần truy cập vào website: https://www.getpostman.com/downloads/. Sau đó lựa chọn nền tảng mà bạn muốn tải (có thể là Windows, Linux hoặc Mac).
Giao diện trang web postman
Last modified 2mo ago