API交互示意圖
開發(fā)流程示意圖
第三方可根據春雨提供的api按照如下大致流程進行開發(fā)
賬號同步/注冊接口
賬號不存在
賬號已存在
URL: /cooperation/server/login
請求方式: POST
請求參數:
返回:
post數據示例
{ "partner": "test", "user_id": "test_user", "password": "12345678", "sign": "cb5a715fdbeb7220", "atime": "1608207278" }
響應示例
{ "error": 0, "error_msg": "user logged in ok" }
普通眾包服務
簡介
指用戶不篩選醫(yī)生資質發(fā)起提問，由春雨通過智能分診匹配合適醫(yī)生；醫(yī)生可以選擇是否認領問題，若在24小時內醫(yī)生未回復，該問題即會被系統(tǒng)關閉。
接入流程
1、申請測試partner和partner_key，并參考基本注意事項。
2、提供第三方接口用于接收醫(yī)生回復通知、問題關閉通知。
3、同步第三方賬戶信息(即調用賬號同步/登陸接口)，對于新用戶發(fā)起一次即可。
4、第三方創(chuàng)建眾包問題（由系統(tǒng)分配科室，或由第三方自主選擇科室）。
5、通過管理后臺模擬醫(yī)生回復問題, 第三方接口問題的回復通知，或者根據需求由春雨人員配合回復醫(yī)生問題。
6、第三方提交用戶追問。
7、第三方發(fā)起問題關閉，并接收問題關閉通知。
8、測試完后，聯系春雨人員開通正式環(huán)境賬戶后即可，第三方需要提供接收業(yè)務警報的郵箱地址。
9、完整的問診流程需要結合通用接口來實現
創(chuàng)建眾包問題接口
URL: /cooperation/server/free_problem/create
{ "user_id": "test_user", "partner": "test", "content": "[{\"type\": \"patient_meta\",\"age\": \"20歲\",\"sex\": \"男\(zhòng)"},{\"type\": \"text\",\"text\": \"創(chuàng)建免費問診問題測試\"}]", "sign": "b26144805c3f88f4", "atime": "1608207611" }
{ "error": 0, "problem_id": 443258121 }
眾包升級服務
即春雨平臺會將用戶問題智能分配給特定醫(yī)生等級或特定醫(yī)院等級的醫(yī)生；比起普通眾包服務，眾包升級具備更優(yōu)質的服務質量。
當用戶發(fā)起提問，春雨平臺首先對匹配的醫(yī)院或醫(yī)生等級進行篩選，而后進行智能分診，若在1小時內沒有回復，系統(tǒng)即自動關閉該問題。
創(chuàng)建眾包升級問題接口
URL: /cooperation/server/problem/create_paid_problem/
{ "user_id": "test_user", "partner": "test", "content": "[{\"type\": \"patient_meta\",\"age\": \"20歲\",\"sex\": \"男\(zhòng)"},{\"type\": \"text\",\"text\": \"創(chuàng)建眾包升級問診問題測試\"}]", "sign": "b26144805c3f88f4", "atime": "1608207611", "partner_order_id": "000001", "pay_type": "qc_hospital_upgrade" }
{ "error": 0, "error_msg": "", "problem_id": 443258122 }
眾包升級問題退款接口
退款條件：醫(yī)生未回答情況下才可調用該接口實現退款
URL: /cooperation/server/problem/refund
{ "user_id": "test_user", "problem_id": "443258127", "partner": "test", "sign": "5a236b488f7eaacc", "atime": "1608208460" }
{ "error": 0, "error_msg": "" }
定向圖文服務
指用戶付費購買指定醫(yī)生的圖文咨詢服務。
包括四種產品形態(tài)：找醫(yī)生/名醫(yī)咨詢/推薦醫(yī)生/搜索醫(yī)生，具體請參見下方的接口說明。
包含兩種服務標準：普通定向咨詢和名醫(yī)咨詢，普通定向咨詢指用戶購買指定醫(yī)生的圖文咨詢，醫(yī)生通過圖文形式耐心細致的解答用戶健康問題，最多30次交互/醫(yī)生首次回復48H后問題關閉；名醫(yī)咨詢是指由春雨平臺精選的各個?？祁I域的大牌專家資源，用戶付費購買后，專家將以圖文形式提供明確、放心的診療建議；需要注意的是，名醫(yī)咨詢最多10次交互/醫(yī)生首次回復48H后問題關閉。
1、申請測試 partner和partner_key，并參考基本注意事項。
3、同步第三方賬戶信息，對于新用戶發(fā)起一次即可。
4、第三方查詢推薦醫(yī)生，獲取醫(yī)生列表。
5、第三方創(chuàng)建付費問診記錄，并引導用戶在第三方APP內進行付費（付費流程由第三方自己實現）。
6、第三方發(fā)送付費成功通知，春雨創(chuàng)建付費問題后返回相關問題信息給第三方。
7、第三方調用相關接口進行問題交互，方法同眾包問題交互一樣。
8、第三方接收問題關閉通知，觸發(fā)方式：第三方主動發(fā)起 或 春雨醫(yī)生拒絕問題。
9、測試完畢后，聯系春雨人員開通正式環(huán)境賬戶后即可，第三方需要提供接收業(yè)務警報的郵箱地址。
10、第三方開發(fā)定向問診需用以下接口結合通用接口來完善整個流程。
找醫(yī)生接口
說明：第三方根據一級科室編號查詢醫(yī)生，獲取醫(yī)生列表；該接口可借助篩選名醫(yī)來實現名醫(yī)咨詢服務，若不篩選名醫(yī)將返回春雨普通醫(yī)生和名醫(yī)
URL: /cooperation/server/doctor/get_clinic_doctors
{ "clinic_no": "1", "famous_doctor": "1", "user_id": "test_user", "start_num": "20", "count": "20", "partner": "test", "sign": "24c0b782f23e71f1", "atime": "1608209559" }
{ "error": 0, "doctors": [{ "clinic_name": "兒科", "second_clinic_name": "小兒科", "good_at": "發(fā)育遲緩、頭痛、遺傳代謝病", "hospital_name": "北京第一醫(yī)院", "hospital_grade": "三級甲等", "id": "0000001", "image": "https://resource.chunyu.mobi/@/media/images/image1.jpg", "name": "測試醫(yī)生", "price": 100, "purchase_num": 771, "title": "主治醫(yī)師", "is_famous_doctor": false, "tel_online": false, "tel_price": "{\"10\": -1, \"15\": -1, \"20\": -1, \"30\": -1}" }, { "clinic_name": "兒科", "second_clinic_name": "小兒科", "good_at": "多動癥、小兒癲癇、抽動癥", "hospital_name": "解放軍總醫(yī)院", "hospital_grade": "三級甲等", "id": "0000002", "image": "https://resource.chunyu.mobi/@/media/images/image2.jpg", "name": "測試醫(yī)生2", "price": 10000, "purchase_num": 1000, "title": "主任醫(yī)師", "is_famous_doctor": true, "tel_online": true, "tel_price": "{\"10\": 16000, \"15\": 24000, \"20\": 40000, \"30\": -1}" }] }
推薦醫(yī)生接口
URL: /cooperation/server/doctor/get_recommended_doctors
{ "ask": "孩子發(fā)燒總不好", "user_id": "test_user", "partner": "test", "sign": "c30cd1025b2e7912", "atime": "1608260984" }
搜索醫(yī)生接口
說明：按照疾病、癥狀、醫(yī)院、科室、醫(yī)生名搜索醫(yī)生（此接口為搜索接口非過濾接口，返回的搜索結果可能與搜索詞存在偏差），一次返回20個醫(yī)生
URL: /cooperation/server/doctor/search_doctor/
{ "user_id": "test_user", "query_text": "頭疼", "famous_doctor": "1", "page": "1", "partner": "test", "sign": "d47372cb2e28ba13", "atime": "1608261465" }
創(chuàng)建定向問題
說明：付費記錄有效時間為1小時
URL: /cooperation/server/problem/create_oriented_problem/
{ "doctor_id": "clinic_web_ae8068a4df5f189e", "content": "[{\"type\": \"patient_meta\",\"age\": \"20歲\",\"sex\": \"男\(zhòng)"},{\"type\": \"text\",\"text\": \"測試創(chuàng)建定向問診問題\"}]", "partner": "test", "partner_order_id": "000001", "price": "200", "user_id": "test_user", "sign": "162c86f9d6c94a65", "atime": "1608262345" }
{ "problem_id": 443258142, "error": 0, "error_msg": "" }
付費問題退款
說明：第三方可借助該接口實現用戶主動發(fā)起付費問題退款，退款只能在醫(yī)生未回答的情況下才能成功。
圖文急診服務
急診服務是一項高效的圖文問診服務。當用戶提問后，能夠得到醫(yī)生快速回復（60秒），圖文急診達到20次交互或醫(yī)生首次回復30分鐘后問題關閉。
服務價格以商務合同中敲定的為準，在接口參數中不做體現。
服務流程
1. 先獲取圖文急診信息
2. 根據獲取到的科室和價格信息創(chuàng)建圖文急診（注意服務時間）
獲取圖文急診信息接口
說明：獲取春雨圖文急診開通的相關信息，包括開通的時間，價格，科室
URL: /cooperation/server/problem/get_emergency_graph_info/
請求方式:POST
{ "user_id": "test_user", "partner": "test", "sign": "6de9382451be403f", "atime": "1608276441" }
{ "error": 0, "clinic_info": [ { "clinic_no": "fa", "clinic_name": "小兒科", "begin": "07:00", "end": "15:45", }, { "clinic_no": "ha", "clinic_name": "皮膚科", "disabled": true } ] }
創(chuàng)建急診問題接口
說明：用戶確定需要問診的急診科室，調用此接口生成付費急診問題
URL: /cooperation/server/problem/create_emergency_graph/
{ "user_id": "test_user", "content": "[{\"type\": \"patient_meta\",\"age\": \"15歲\",\"sex\": \"男\(zhòng)"},{\"type\": \"text\",\"text\": \"測試創(chuàng)建急診問診問題\"}]", "clinic_no": "fa", "partner_order_id": "1700", "partner": "test", "sign": "64bff638925fecea", "atime": "1608284147" }
{ "problem_id": 443258195, "error": 0, "error_msg": "" }
通用接口
問題追問接口
URL: /cooperation/server/problem_content/create
{ "user_id": "test_user", "partner": "test", "problem_id": "443258196", "content": "[{\"type\": \"text\",\"text\": \"測試追問\"}]", "sign": "1bad37f433370896", "atime": "1608285064" }
{ "error": 0, "content_id": 11536441 }
問題詳情接口
URL: /cooperation/server/problem/detail
n 新問題
n
a 已認領---醫(yī)生認領,等待醫(yī)生回答
a
s 已回復
s
c 已關閉
c
p 被舉報---因為含有違禁詞/辱罵醫(yī)生等原因被舉報
p
狀態(tài)轉換示意圖 點擊查看
狀態(tài)轉換示意圖
{ "user_id": "test_user", "problem_id": "443258234", "partner": "test", "sign": "d3ba697b786a9a17", "atime": "1608449384" }
{ "problem": { "id": 443258234, "status": "a", "ask": "醫(yī)生你好，測試創(chuàng)建眾包升級問題（男，40歲）", "clinic_no": "2", "star": -1, "level": "", "has_assessed": false, "interaction": 1 }, "content": [ { "id": 11536625, "type": "p", "content": "[{\"text\": \"醫(yī)生你好，測試創(chuàng)建眾包升級問題（男，40歲）\", \"type\": \"text\"}]", "created_time_ms": 1608450103000 }, { "id": 11536628, "type": "d", "content": "[{\"text\": \"快速醫(yī)生回復，時間: 2020-12-20 15:42:02.676034\", \"type\": \"text\"}]", "created_time_ms": 1608450123000 }, { "id": 11536629, "type": "p", "content": "[{\"text\": \"測試追問\", \"type\": \"text\"}]", "created_time_ms": 1608450134000 } ], "doctor": { "id": "clinic_web_ae8068a4df5f189e", "name": "測試醫(yī)生", "image": "https://test.chunyutianxia.com/media/images/fc7d/8968fe2e5cb5?imageMogr2/thumbnail/150x", "title": "主治醫(yī)師", "level_title": "二級甲等醫(yī)院主治醫(yī)師", "clinic": "2", "hospital": "上饒市婦幼保健院" }, "error": 0, "error_msg": "" }
醫(yī)生詳情接口
URL: /cooperation/server/doctor/detail
{ "user_id": "test_user", "doctor_id": "04c580dbeb2007220123", "partner": "test", "sign": "4d7de1d90f54c62d", "atime": "1608518154" }
{ "id": "04c580dbeb2007220123", "name": "測試醫(yī)生", "image": "https://resource.chunyu.mobi/@/media/images/99b3/5f9530432279?imageMogr2/thumbnail/150x", "title": "主治醫(yī)師", "clinic_name": "小兒科", "hospital": "北京301醫(yī)院", "hospital_grade": "三級甲等", "good_at": "臨床工作20多年，經驗豐富，擅長小兒呼吸道感染等診治。", "solution_score": 98, "recommend_rate": 88, "good_rate": 92.8, "description": "", "price": 2500, "tags": [ "百強醫(yī)院", "從業(yè)26年", "北京市市" ], "reward_num": 7, "reply_num": 942, "fans_num": 55, "is_famous_doctor": false, "education": "1994年上海第二醫(yī)科大學兒科系畢業(yè)，2006年去香港瑪麗醫(yī)院進修。", "achievement": "", "welcome": "歡迎關注我的小兒科個人診所，希望能為你提供健康方面的幫助。", "tel_price": "{\"10\": 1000, \"15\": -1, \"20\": -1, \"30\": -1}", "tel_online": true, "error": 0, "error_msg": "" }
醫(yī)生總結信息
說明：
在咨詢過程中或服務關閉后7天內，醫(yī)生可通過圖文形式向用戶下發(fā)總結。醫(yī)生總結是醫(yī)生的可選交流方式，并非所有問題都會下發(fā)總結。
總結信息可通過兩種方式傳達到合作方：1、通過【醫(yī)生回復通知接口】以回調形式同步；2、通過【問題詳情接口】同步。在這兩種方式中，會對醫(yī)生總結進行特殊標識，具體請參見接口規(guī)范。
醫(yī)生可多次撰寫總結，但春雨平臺側每個問題只會保留一份總結，以最后一次為準（即推送可能收到多次，但問題詳情接口里只會體現一份總結，合作方可酌情設計該功能）。
查詢問題分配科室接口
URL: /cooperation/server/problem/get_problem_clinic_no/
{ "user_id": "test_user", "partner": "test", "ask": "渾身發(fā)熱，沒勁", "sign": "fdb57eee1bb66c91", "atime": "1608518632" }
{ "error": 0, "error_msg": "", "clinic_no": "aa" }
評價問題接口
服務細則
1、問題未關閉時，交互3次以上可進行評價
2、問題關閉后：關閉后30天內可以評價；接收評價的有效期為問題關閉后30天內，超過30天，不能再評價；測試環(huán)境的有效期為問題關閉后1小時
3、評價次數限制：每個問題僅支持接收一次評價數據
接口信息
URL: /cooperation/server/problem/assess
{ "bad": { "1101": '不友好', "1102": '不細致', "1201": '等好久沒回復', "1301": '完全聽不懂', "1302": '感覺不專業(yè)', "1303": '沒有幫助',} "good": { "2101": '希望更熱情', "2102": '希望更細致', "2201": '希望回復更快', "2301": '希望講得更透徹',} "best": { "3101": '態(tài)度非常好', "3102": '非常清楚', "3201": '回復很及時', "3301": '非常專業(yè)認真', "3302": '意見很有幫助', "3303": '非常敬業(yè)',} }
{ "user_id": "test_user", "partner": "test", "problem_id": "443258196", "assess_info": "{\"level\": \"best\", \"tag_keys\":[\"3201\", \"3102\"]}", "content": "[{\"type\": \"text\",\"text\": \"醫(yī)生解答的挺好的，給個好評。\"}]", "sign": "fdb57eee1bb66c91", "atime": "1608518632" }
問題刪除接口
刪除問題后，"我的提問歷史"接口中，會刪除掉這個問題。
注意：問題未關閉時調用此接口時，會先關閉問題。請用戶確保問診完畢，不需要和醫(yī)生交互后使用。
URL: /cooperation/server/problem/delete
{ "user_id": "test_user", "partner": "test", "problem_id": "443258241", "atime": "1608519397", "sign": "7d752c229c9cd583" }
問題關閉接口
說明：第三方通過此接口主動關閉問題，主動關閉條件：狀態(tài)不是已關閉且醫(yī)生有回復
URL: /cooperation/server/problem/close
{ "user_id": "test_user", "partner": "test", "problem_id": "443258242", "atime": "1608519713", "sign": "8fddaee19d525886" }
我的提問歷史
URL: /cooperation/server/problem/list/my
{ "user_id": "test_user", "start_num": "0", "count": "10", "partner": "test", "sign": "3bb28a7c0f4a463e", "atime": "1608520177" }
[{ "problem": { "id": 443258245, "status": "a", "star": 5, "to_doc": false, "price": 6.0, "title": "醫(yī)生您好，測試創(chuàng)建眾包問題（...", "ask": "醫(yī)生您好，測試創(chuàng)建眾包問題（男，40歲）", "clinic_no": "2", "has_answer": true, "flag": "n", "created_time_ms": 1608519977000, "assess_remark": "挺好的，評價一下這個。", "clinic_name": "兒科", "created_time": "2020-12-21 11:06:17", "need_assess": false, "level": "best" }, "doctor": { "id": "clinic_web_ae8068a4df5f189e", "name": "測試醫(yī)生", "title": "主治醫(yī)師", "image": "https://test.chunyutianxia.com/media/images/fc7d/8968fe2e5cb5?imageMogr2/thumbnail/150x", "clinic_no": "2", "clinic": "小兒科", "hospital": "上饒市婦幼保健院", "hospital_grade": "二級甲等", "level_title": "二級甲等醫(yī)院主治醫(yī)師" } }]
H5資源訪問登錄跳轉
URL: /cooperation/saas/login_redirect/
請求方式: GET
示例：
其中問診記錄測試環(huán)境url：
http://www.ruichenmed.cn/cooperation/wap/my_all_services_page/?partner=xxx&from_saas=1
嵌套登錄接口后下發(fā)給用戶端：
http://www.ruichenmed.cn/cooperation/saas/login_redirect/?url=https%3A%2F%2Fwww.ruichenmed.cn%2Fcooperation%2Fwap%2Fmy_all_services_page%2F%3Fpartner%3Dxxxx%26from_saas%3D1&partner=xxx&atime=1676883201&user_id=test_user1&sign=1f46b8e32d7ebd2e
退款及舉報邏輯
針對眾包升級、定向圖文類型的付費問題，涉及到如下退款場景時，將下發(fā)對應的系統(tǒng)通知和文案
退款類型
1、退款類型共包括5類，具體參見下表《退款類型》
2、舉報邏輯與被舉報引起的退款（具體參見表《因被舉報引起的退款邏輯》）
規(guī)則說明1：問題因被系統(tǒng)舉報或被醫(yī)生舉報可能引發(fā)退款，舉報邏輯共包括4種類型，其中3種涉及退款；
規(guī)則說明2：凡被舉報的問題，平臺側都會下發(fā)多次推送通知，第1次下發(fā)關閉通知，是否做退款處理請以第2次通知為準，具體處理邏輯及文案細節(jié)見表；
因被舉報引起的退款邏輯
問題被舉報時會被立即關閉。若此時醫(yī)生尚未回復，則退款；若醫(yī)生回復后被醫(yī)生舉報，則先關閉問題，由客服審核舉報，如果醫(yī)生舉報正確，則不退款；醫(yī)生舉報錯誤則退款并降低醫(yī)生的指數。通知關閉情況見圖：
黑名單邏輯
當問題被醫(yī)生舉報并達到一定次數時，該用戶將被拉入春雨平臺的黑名單中；當用戶被拉入黑名單后，將導致該用戶后續(xù)創(chuàng)建問題失敗.
錯誤信息為："因違背提問原則，此功能暫不可用。如有疑問請聯系春雨客服"
回調管理
回復通知接口
當服務被醫(yī)生回復、總結時，春雨主動請求合作方配置的鏈接地址，傳遞醫(yī)生回復數據。
1.服務關閉和服務退款兩個通知并不互斥，在特殊場景中（特殊情況：已交互的問題被舉報時）會先關閉服務；2.各類服務都可調用該接口，如同時接入多種服務類型，傳不同的參數即可，根據status區(qū)分來自哪種服務類型。
URL: 即合作方管理后臺-賬戶管理-信息配置中填寫的回復回調路徑
reply 醫(yī)生回復
reply
{ "error": 0, // 0 代表成功,其它 代表異常 "error_msg": "" //錯誤信息 }
服務關閉通知接口
當服務關閉、退款等狀態(tài)變更時，春雨主動請求合作方配置的鏈接地址，傳遞訂單狀態(tài)數據。
開發(fā)時請注意：問題關閉和問題退款兩個通知并不互斥，在一些場景中會先關閉問題
URL: 即合作方管理后臺-賬戶管理-信息配置中填寫的關閉回調路徑
close 回答完畢后關閉
close
refund 問題退款
refund
服務創(chuàng)建通知接口
當圖文服務創(chuàng)建時，春雨主動請求合作方配置的鏈接地址，傳遞訂單狀態(tài)數據。
常見錯誤碼
系統(tǒng)文案
API接入合作方可考慮自行增加以下系統(tǒng)消息邏輯以優(yōu)化用戶體驗
