示例框架 laravel 5.x + 官方sdk + 釘釘小程序
如果不使用官方SDK包 可通過composer安裝插件(非官方開發(fā))
插件地址:https://github.com/mingyoung/dingtalk
釘釘步驟
1、注冊企業(yè)釘釘
2刀疙、按照文檔:https://ding-doc.dingtalk.com/doc#/serverapi2/dr0du9 根據(jù)自身需求 選擇創(chuàng)建微應(yīng)用H5 or 釘釘小程序(我選擇小程序)
3、應(yīng)用首頁中設(shè)置IP白名單扫倡,安全URL谦秧,接口權(quán)限(我選擇通訊錄,審批等權(quán)限),創(chuàng)建審批模板流程等
Ps:創(chuàng)建審批模板的時(shí)候可以在url中獲取PROCESS_CODE撵溃,發(fā)起審批的必傳參數(shù)
4疚鲤、通過創(chuàng)建釘釘小程序得到corpid AppKey AppSecret 用于獲取token等
框架步驟
1、下載釘釘sdk-php版(https://ding-doc.dingtalk.com/doc#/faquestions/vzbp02)
2缘挑、解壓后刪除無用文件 aliyun,QimenCloud 兩個(gè)目錄后集歇,重命名目錄 dingdingsdk
3、將sdk放入到自己合適的項(xiàng)目目錄下(我選擇extend目錄)
4语淘、修改根目錄 composer.json文件诲宇,autoload字段的files值 新增extend//dingdingsdk/TopSdk.php用于框架自動(dòng)加載
5、命令行 根目錄下運(yùn)行 composer dump-autoload 更新加載器
6惶翻、.env文件添加自己需要用到的配置常量
例如:
DINGDING_DEV 如不設(shè)置 默認(rèn)為調(diào)用測試模板 TRUE則為線上
DINGDING_KEY 釘釘key - 開發(fā)后臺->應(yīng)用首頁->應(yīng)用詳情
DINGDING_SECRET 釘釘服務(wù)的secret - 開發(fā)后臺->應(yīng)用首頁->應(yīng)用詳情
DINGDING_CALLBACKURL 釘釘審批事件回調(diào)地址 - 線上審批回調(diào)地址(測試地址為:https://wyx.jinshuizhiguan.com/api/admin/dingdingcallback)
DINGDING_TOKEN 加解密需要用到的token姑蓝,ISV(服務(wù)提供商)推薦使用注冊套件時(shí)填寫的token,普通企業(yè)可以隨機(jī)填寫+-*//*-
DINGDING_AESKEY 數(shù)據(jù)加密密鑰吕粗。用于回調(diào)數(shù)據(jù)的加密纺荧,長度固定為43個(gè)字符,從a-z, A-Z, 0-9共62個(gè)字符中選取,您可以隨機(jī)生成颅筋,ISV(服務(wù)提供商)推薦使用注冊套件時(shí)填寫的EncodingAESKey 或者自己寫43個(gè)字符宙暇,例如(測試):xxxx2222lvdhntotr3x9qhlbytb18zyz5zxxxxxxxxx
DINGDING_SUITEKEY 使用注冊時(shí) CorpId 即可(開發(fā)者后臺首頁)
7、可以在sdk目錄創(chuàng)建一個(gè)共用api
調(diào)用釘釘接口(在線測試平臺中有不同代碼版本的調(diào)用示例):
1议泵、發(fā)起審批需要有對應(yīng)的模板ID 例如:PROC-2604BD64-F743-4847-A497-20D35F04NCN8
2占贫、實(shí)例化 & 獲取釘釘token 因?yàn)樽詣?dòng)加載 可以直接調(diào)用方法
//前面要加 ‘ \ ’ \DingTalkConstant::$METHOD_POST 請求類型 可以在調(diào)用之前進(jìn)行修改
$dingding = new \DingTalkClient(\DingTalkConstant::$CALL_TYPE_OAPI, \DingTalkConstant::$METHOD_POST , \DingTalkConstant::$FORMAT_JSON);
//獲取token 使用自己小程序的key & secret
$req = new \OapiGettokenRequest;
$req->setAppkey(env('DINGDING_KEY', 'dingxxxxxxxxxxx'));
$req->setAppsecret(env('DINGDING_SECRET', 'xxxxxxxxxxxxxxxx'));
//重新設(shè)置請求類型為 GET
$dingding->httpMethod = 'GET';
//第二參數(shù)為token 沒有時(shí)候傳null 第三參數(shù)為請求地址 文檔中有示例
$resp = $dingding->execute($req, null, "https://oapi.dingtalk.com/gettoken");
//如果請求IP不在白名單中 則返回格式為 code msg ,errcode可能沒有這個(gè)參數(shù)肢簿,這點(diǎn)要注意(第一處 踩坑) 格式均為json返回
if(isset($resp->errcode) && $resp->errcode == 0)
{
return $resp->access_token;
}
//完整返回值
{
"errcode": 0,
"errmsg": "ok",
"access_token": "fw8ef8we8f76e6f7s8df8s"
}
3靶剑、所有接口調(diào)用 在官方文檔中均有示例,如果想要得到PHP版 可以從在線接口測試平臺得到池充,下面舉例發(fā)起審批
$req = new \OapiProcessinstanceCreateRequest;
$processCode = 'PROC-2604BD64-F743-4847-A497-20D35F04NCN8';
$req->setProcessCode($processCode); //審批模板唯一標(biāo)識碼
//如果沒有釘釘ID 可以通過 通訊錄->用戶管理 根據(jù)手機(jī)號獲取 文檔:[https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/soV11]
$req->setOriginatorUserId(這里為釘釘ID); //發(fā)起人ID
//發(fā)起人所在部門可以根據(jù)釘釘userid獲取 接口文檔:
$req->setDeptId(部門ID);
//添加表單這里 一定一定要注意格式 官方文檔中沒有提到多個(gè)的例子
$data = [];
foreach($params['list'] as $key => $item)
{
$form = new \FormComponentValueVo; //設(shè)置表單參數(shù)
$form->name=$item['name']; //每一欄名稱
$form->value=$item['value']; //每一欄值
$data = array_merge($data, [$form]);
}
//表單參數(shù)
$req->setFormComponentValues($data);
$dingding>httpMethod = 'POST'; //修改請求方式
$resp = $dingding->execute($req,上面獲取的access_token,"https://oapi.dingtalk.com/topapi/processinstance/create");
4桩引、注冊回調(diào)事件, 因?yàn)橹挥玫搅?審批,所以此處只注冊了審批的回調(diào)
bpms_task_change:發(fā)起的審批通過和拒絕收夸,返回的事件類型bpms_instance_change:發(fā)起的審批撤銷了坑匠,返回的事件類型
釘釘?shù)幕卣{(diào)事件 可以進(jìn)行刪除(整體刪除),修改卧惜,也可以獲取已經(jīng)注冊回調(diào)的參數(shù)詳情 厘灼,可以參考文檔
$req = new \OapiCallBackRegisterCallBackRequest;
//此處傳遞的監(jiān)聽事件夹纫,根據(jù)自己需求選擇,切記 切記 切記 傳參是個(gè)字符串设凹,里面是個(gè)數(shù)組(第二處 踩坑)舰讹。。闪朱。月匣。官方舉例只有單個(gè)“bpms_task_change” 類似于這種
$req->setCallBackTag("['bpms_task_change','bpms_instance_change']");
$req->setToken(加解密用的token 自行設(shè)置);
$req->setAesKey(aes_key 上面有格式舉例,自行設(shè)置);
//回調(diào)URL地址 必須為公網(wǎng)
$req->setUrl(回調(diào)的公網(wǎng)地址);
$dingding->httpMethod = 'POST'; //設(shè)置請求方式
$resp = $dingding->execute($req,上面獲取的access_token, "https://oapi.dingtalk.com/call_back/register_call_back");
5奋姿、當(dāng)注冊成功后 釘釘官方會進(jìn)行請求锄开,確認(rèn)接口是否可用,此時(shí) 需要給官方返回字符串 success 的加密串 称诗,進(jìn)行確認(rèn)萍悴。加/解密可以看參考資料 記得替換函數(shù)。
tail -f 觀察nginx請求日志可以得到回調(diào)信息寓免,使用命令行在本地測試請求:
curl 'http://www.zbkj_site.com/api/admin/dingdingcallback?signature=54028798ed15a239ffa4ec8e3008791ae0c67528×tamp=1592887313454&nonce=IkK7MCr5' -d '{"encrypt":"uuAEcGOkIZ1l7ymCqVQBk+iZcgUVV+OK9vC3r/kcdZV+1PLREsqKsdn05UdmFn+GI6dWM8JQZ1e7vfVQTBggwTqXnNFPZfIHIoCAyz2s+zDf5HXKyh6lFeg03T54L+es"}' -H 'Content-Type:application/json'
encrypt 解密后
$data = array(2) {
["errCode"]=>
int(0)
["msg"]=>
string(25) "{"EventType":"check_url"}"
}
解密出來的msg 進(jìn)行 $eventMsg = json_decode($data['msg']);
$eventType = $eventMsg['EventType'];
//通過switch進(jìn)行判斷癣诱,對應(yīng)的case 中書寫自己的邏輯,數(shù)據(jù)狀態(tài)扭轉(zhuǎn)等
switch($eventType)
{
case "bpms_task_change":
//審批任務(wù)開始再榄,結(jié)束狡刘,轉(zhuǎn)交
break;
case "bpms_instance_change":
//審批實(shí)例開始,結(jié)束
break;
}
調(diào)用官方demo的加密方法
$timestamp困鸥, $nonce 用官方傳遞給我們的就可以嗅蔬,直接echo輸出返回
echo EncryptMsg('success', $timestamp, $nonce, '');
參考資料:
官方文檔:https://ding-doc.dingtalk.com/doc#/serverapi2/dr0du9
在線調(diào)試地址:https://open-dev.dingtalk.com/apiExplorer#/?devType=org&api=/processinstance/create
錯(cuò)誤碼:https://ding-doc.dingtalk.com/doc#/faquestions/rftpfg
權(quán)限申請:https://ding-doc.dingtalk.com/doc#/serverapi2/ca8r99
審批接入:https://ding-doc.dingtalk.com/doc#/serverapi2/tvu5f4
創(chuàng)建模板:https://ding-doc.dingtalk.com/doc#/serverapi2/tvu5f4
EncodingAESKey說明:https://ding-doc.dingtalk.com/doc#/faquestions/ltr370
替換mcrypt 7.1版本之后已經(jīng)被遺棄:https://blog.csdn.net/zfh168/article/details/83028183
釘釘加/解密php-demo:https://github.com/injekt/openapi-demo-php/tree/master/isv/crypto