客製人事系統

此頁面將介紹一系列API介面，給使用自製的人事系統而非LDAP的客戶，使其同樣能將使用者及部門資料將同步至OMFLOW。

注意：此API需要由中介應用程式提供，並由OMFLOW進行呼叫。

憑證

強烈建議中介應用程式使用ＳＳＬ／ＴＬＳ憑證，以確保資料傳輸安全。

同步資料

說明：OMFLOW將呼叫此API進行人員及部門的資料同步，請將第三方的人員及部門資料整理成下列資料格式。

Method：POST

URL：/sync

Basic Authentication：True

Content-Type：application/json

回傳資料

成功時，回傳資料範例如下：

{
    "status": "success",
    "user_info_list" : [{
            "username": "<帳號>",               //(唯一值)
            "email": "<Email>",                //(唯一值)
            "nick_name": "<人員名稱>",
            "ad_no": "<員工編號>",
            "company": "<公司>",
            "phone1": "<電話>",
            "phone2": "<手機>",
            "extension_no": "<分機>",
            "gender":"<性別 male/female>"
        },...
    ],
    "group_info_list": [{
            "display_name": "<部門名稱>",
            "group_no": "<部門代號>",           //(唯一值)
            "parent_group_no": "<父部門代號>",
            "user_list": [
                "<username1>", 
                "<username2>",
                ...
                ]
        },...
    ]
}

失敗時，回傳資料範例如下：

{
    "status": "fail",
    "message": "<錯誤訊息>"
}

注意：

• username、email及group_no為唯一值。

• OMFLOW將以username及group_no判斷為相同的人員及部門，若此次同步資料與前一次同步資料不同時，將進行新增、修改及刪除的動作。

登入

同步資料後，使用者登入時，OMFLOW會呼叫此API進行驗證。 OMFLOW發送請求內容如下:

{"username": "<帳號>", "password": "<密碼>"}

請依此內容進行登入審核，並回傳審核結果。

注意： 請自行實作登入驗證方式，並依下列格式回傳結果

Method：POST

URL：/authenticate

Basic Authentication：True

Content-Type：application/json

回傳資料

登入驗證成功時，回傳資料範例如下：

{
    "status": "success"
}

登入驗證失敗時，回傳資料範例如下：

{
    "status": "fail",
    "message": "<錯誤訊息>"
}