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

Các thông tin cơ 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/khachhang01 thì 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ẽ ghi GET {domain}/api/v1/agents. Khi truy xuất sẽ nối chuỗi thành https://api.caresoft.vn/{domain}/api/v1/agents

Cách lấy Api Token trên giao diện CareSoft

Để 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 token

Bạ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.

Phương thức xác thực

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 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'

Tạo request đầu tiên

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

Lấy danh sách Agents

GET {{domain}}/api/v1/agents

Lấy danh sách các agent của 1 domain trên hệ thống CareSoft

Headers

{
    "code": "ok",
    "agents": [
        {
            "id": 142928097,
            "username": "Sample",
            "email": "DiegoS@50pdp0.onmicrosoft.com",
            "phone_no": "0336842288",
            "agent_id": "50007",
            "created_at": "2022-07-08 09:48:41",
            "updated_at": "2022-08-08 17:42:08",
            "group_id": 12153,
            "group_name": "Default Group",
            "role_id": 1,
            "login_status": "AVAILABLE",
            "call_status": "AVAILABLE"
        }
        ]
}

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

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'

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

THAM KHẢO

  • 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).

Last updated