添加 Home

Home.md

@@ -0,0 +1,33 @@
+<div align="center">
+<h1>云码平台 - 商家接入文档</h1>
+</div>
+
+
+## 商家 API 接口 根地址
+
+正式环境：<a href="http://api.cc.line92.com" target="_blank">http://api.cc.line92.com</a>
+
+测试环境：<a href="http://test.api.cc.line92.com" target="_blank">http://test.api.cc.line92.com</a>
+
+## 阅读 API 功能文档
+
+<a href="http://test.api.cc.line92.com" target="_blank">http://test.api.cc.line92.com</a>
+
+## 商家身份鉴权
+
+几乎所有的 API 都要求验证权限，请在 HTTP 请求头中添加您账号的 JWT Token ：
+
+- Header Key：Authorization
+- Header Value：Bearer XXXXXXXXXXX （<a href="http://admin.cc.line92.com/#/profile/merchant" target="_blank">在此页面按下F12查看</a>）
+
+## 短信接码流程
+1. 获取手机号（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/sms.code/api-adm-sms.code-get.phone-Post" target="_blank">文档</a>）
+2. 拿到手机号输入目标程序发送验证码
+3. 获取验证码（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/sms.code/api-adm-sms.code-query-Post" target="_blank">文档</a>），此步骤需要多次尝试，建议设定请求间隔为5s，持续5min
+4. 释放手机号（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/sms.code/api-adm-sms.code-release.phone-Post" target="_blank">文档</a>），如果调用步骤2多次未获取到验证码，需要放弃此号继续做下一个任务时，请调用此接口（可停止计费，避免损耗）
+
+## 邮箱接码流程
+1. 获取邮箱号（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/mail.code/api-adm-mail.code-get.email-Post" target="_blank">文档</a>）
+2. 拿到邮箱号输入目标程序发送验证码
+3. 获取邮件码（<a href="http://test.api.cc.line92.com/index.html#/%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1/mail.code/api-adm-mail.code-get-Post" target="_blank">文档</a>），此步骤需要多次尝试，建议设定请求间隔为5s，持续5min
+