Tài liệu Open API tích hợp Hợp đồng số MISA weSign

(Site demo: 

628e2f6d-d403-4ea3-bf4a-9dbb980c2600)

(Site demo: 

cc04ddf8-1f6d-4dfb-a2ea-188d80d8a24f)

Test: https://testapiwesign.misa.vn

Demo: https://demoamisapp.misa.vn/wesign/api/public

Đối tác/KH gửi link callback để Dự án Wesign thiết lập phản hồi

– Tải về file mẫu callback

https://amisapp.misa.vn/login?clientID={x-client-id}&redirectUri={redirectUri}

VD: https://amisapp.misa.vn/login?clientID={x-client-id}&redirectUri={https://google.com}

x-client-secret: {x-client-secret}

x-amis-sid: {sid}

Authorization: {access token}

{

“ErrorCode“: “Mã lỗi“,

“DevMsg“: “mô tả thông tin lỗi cho người phát triển“,

“UserMsg“: “mô tả thông tin lỗi cho người dùng“,

“TraceId“: “Mã để tra cứu thông tin“,

“MoreInfo“: “Thông tin khác“,

“AccessToken“: “giá trị access token“,

}

Nhận về x-client-id và x-client-secret

Lưu ý:

– Token có hạn được trả về qua thông tin acccessExpAt

    “x-client-id“: “{x-client-id}”,

    “x-client-secret“: “{x-client-secret}”,

    “x-amis-sid“: “{SID}”

}

    “accessToken“: “mã token”,

    “acccessExpAt“: “hạn token”,

    “refreshToken“: “mã làm mới token”,

    “refreshTokenExpAt“: “hạn của mã làm mới”

}

Lưu ý: Lưu lại thông tin {accessToken} để sử dụng cho các api phía sau

    “x-refresh-token“: “{accessToken}”

}

    “Authorization“: “Bearer {accessToken}”

}

{

   “Data”: “RequestUploadData“

   “Files”: “@<path-to-file>” //đường dẫn file tài liệu

}

API sẽ tìm vị trí của các key để tạo ra thông tin ký trả về positionSignatures ở response

Lưu ý: Lưu lại thông tin của response để sử dụng cho các api phía sau

    “Authorization“: “Bearer {accessToken}”

}

Lưu ý: Lưu lại thông tin để sử dụng cho các api phía sau

    “Authorization“: “Bearer {accessToken}”

}

        “Take“: 100, //số lượng bản ghi lấy ra

        “Skip“: 0, //số lượng bỏ qua

        “Keyword“: “từ khóa tìm kiếm theo tên tài liệu”

}

   {

        “id“: “id của tài liệu”,

        “name“: “tên tài liệu”

   }

]

    “Authorization“: “Bearer {accessToken}”

}

Lưu ý: Lưu lại thông tin để sử dụng cho các api phía sau

    “Authorization“: “Bearer {accessToken}”

}

{

        “Files“: “File excel chứa nội dung trộn”,

        “IsNotAllowCoordinatorEdit“: true/false, //Có cho người điều phối chỉnh sửa hay không

        “DocumentTemplateId“: “id của mẫu lấy từ danh sách mục 3.2″

}

    “success“: true/false, //trạng thái trộn

    “code“: “thông tin gửi về”,

    “message“: “thông báo”,

    “systemMessage“: “thông báo của hệ thống”,

    “data“: “tên tài liệu”,

    “subCode“: “tên tài liệu”,

    “userMessage“: “tên tài liệu”,

    “validateInfo“: “danh sách thông tin kiểm tra”

}

Luồng ký sẽ được tạo và tự động gửi cho người cần ký

Các thông tin về luồng ký sẽ trả về callback

    “Authorization“: “Bearer {accessToken}”

}

        “documentID“: “File excel chứa nội dung trộn”,

        “batchName“: true/false, //Có cho người điều phối chỉnh sửa hay không

        “isNotAllowCoordinatorEdit“: “id của mẫu lấy từ danh sách“

        “mergeDatas“: “danh sách mappingField” //lấy danh sách từ chi tiết tài liệu

}

Mỗi mappingField là 1 list các phần tử

{

      “mappingField”: “DocumentName”, // tên trường mapping

      “typeMappingField”: 0,

      “value”: “giá trị thay thế”

}

muốn tạo ra bao nhiêu tài liệu thì thêm từng đó list mappingField

Định nghĩa typeMappingField

0: kiểu của hệ thống (chỉ sử dụng với mappingField = DocumentName và AsyncID)

1: dùng cho thông tin ký của các bên (là thông tin jobPosition truyền vào mappingField lấy từ api Lấy chi tiết mẫu (yêu cầu truyền đúng text)

2: trường trộn

    “success“: true/false, //trạng thái trộn

    “code“: “tên tài liệu”,

    “message“: “tên tài liệu”,

    “systemMessage“: “tên tài liệu”,

    “data“: “tên tài liệu”,

    “subCode“: “tên tài liệu”,

    “userMessage“: “tên tài liệu”,

    “validateInfo“: “danh sách thông tin kiểm tra”

}

tương tự với trộn excel, nhưng thông tin các trường trộn được thể hiện ở body dưới dạng json

    “Authorization“: “Bearer {accessToken}”

}

        “reason“: “Lý do hủy”,

        “docIds“: [Danh sách tài liệu hủy],

        “device“: “thông tin thiết bị hủy”

        “emailTemplateId“: “”

}

Hoặc trường hợp lỗi

{

        “ErrorCode“: “mã lỗi”,

        “DevMsg“: “Diễn giải lỗi”,

        “UserMsg“: “Diễn giải lỗi”,

        “MoreInfo“: “thông tin khác nếu có”,

        “TraceId“: “”,

        “AccessToken“: “”,

        “ValidationFailures“: “”

}

    “Authorization“: “Bearer {accessToken}”

}

   Danh sách id tài liệu

]

   {

        “document“: “Thông tin của tài liệu của api SignFlow”,

        “listDocumentParticipant“: “Danh sách cks có trong tài liệu”

   }

]

document.status: trạng thái ký của tài liệu

0: tài liệu chưa hoàn thành

1: tài liệu đã hoàn thành

3: tài liệu bị từ chối

5: tài liệu bị hủy bỏ

    “Authorization“: “Bearer {accessToken}”

}

{

        “listTemplateSignInvitation“: “Danh sách mẫu mail mời ký”,

        “listTemplateDistributeInvitation“: “Danh sách mẫu mail mời điều phối”,

        “listTemplateApprovalInvitation“: “Danh sách mẫu mail mời phê duyệt”,

        “listTemplateSignReject“: “Danh sách mẫu mail từ chối ký”,

        “listTemplateApprovalReject“: “Danh sách mẫu mail từ chối phê duyệt”,

        “listTemplateSignComplete“: “Danh sách mẫu mail hoàn thành tài liệu”

}

]

Đối tượng của các list có định dạng:

{

        “id“: “id của mẫu email”,

        “name“: “Tên mẫu email”,

        “content“: “nội dụng email dạng html”,

        “title“: “nội dụng email dạng html”,

        “dataMerge“: “nội dụng email dạng html”

}

    “Authorization“: “Bearer {accessToken}”

}

        “fileContents“: “nội dung file dạng byte”,

        “contentType“: “định dạng file” //thường là file zip

}

    “Authorization“: “Bearer {accessToken}”

}

        “fileContents“: “nội dung file dạng byte”,

        “contentType“: “định dạng file” //thường là file zip

}

Mô tả Enum Role

Các job đặc thù

Họ và tên (khách hàng): Họ tên người nhận ký

Email (khách hàng): Email người nhận ký

Số điện thoại (khách hàng): số điện thoại gửi SMS đến người nhận ký

0: người ký, 

1: người nhận bản sao, 

2: Người điều phối, 

3: Người phê duyệt

1 = tiếng Anh,…

0: Không làm gì cả

1: Đang chờ người này ký

2: Đã ký

3: Đã từ chối

4: Đang chờ điều phối

5: Đã điều phối

6: Đang chờ phê duyệt 

7: Đã phê duyệt 

8: Đã ủy quyền 

9: Đã bị hủy ủy quyền

1: Người nhận bản sao

2: Người điều phối

3: Người phê duyệt