1.1 生成CPS推广链接
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>生成CPS推广链接</li>
</ul>
<p>默认接口请求频率限制：30次/秒。</p>
<h5>请求URL</h5>
<ul>
<li><code>/shoppingguide-jh-business/v1/share/zhichi/create</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST
智齿 -> 官网
<pre><code>分享装修页
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;RENOVATION_PAGE&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;pageId&quot;: &quot;109727&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>分享内容页
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;CONTENT_PAGE&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;pageId&quot;: &quot;998&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>分享商详页
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;GOODS&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;spuOuterId&quot;: &quot;KYYR010-3&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>我的门店
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;MY_STORE&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>小程序首页
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;HOMEPAGE&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>抽奖活动
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;LOTTERY&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;shareParams&quot;: &quot;123456&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>抽签活动
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;DRAW&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;shareParams&quot;: &quot;123456&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>商品列表
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;GOODS_LIST&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;shareParams&quot;: &quot;{\&quot;goodsChannel\&quot;:\&quot;0\&quot;,\&quot;keyword\&quot;:\&quot;关键词\&quot;}&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>集卡活动
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;JK&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;shareParams&quot;: &quot;123456&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>计步签到活动
{
&quot;employeeId&quot; : &quot;01222210&quot;,
&quot;sharePageType&quot; : &quot;BBYL&quot;,
&quot;channel&quot; : &quot;SUN_CODE&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;shareParams&quot;: &quot;123456&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;needWxLink&quot;: true
}</code></pre>
<pre><code>线上跑
{
&quot;employeeId&quot;:&quot;01222210&quot;
&quot;sharePageType&quot;:&quot;ONLINE_RUNNING&quot;
&quot;channel&quot;:&quot;SUN_CODE&quot;
&quot;outChannel&quot;:&quot;SINGLE_CHAT&quot;
&quot;shareParams&quot;:&quot;702060918684327&quot;
&quot;materialInfo&quot;:&quot;素材信息&quot;
&quot;needWxLink&quot;:true
}</code></pre>
<h5>参数</h5></li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">employeeId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>员工ID</td>
<td>0开头在职员工id或者经销商员工(以_1结尾)</td>
</tr>
<tr>
<td style="text-align: left;">sharePageType</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>分享页面</td>
<td>默认小程序首页HOMEPAGE,装修页RENOVATION_PAGE,内容页面CONTENT_PAGE,商详页GOODS,我的门店:MY_STORE, 抽签:DRAW, 抽奖:LOTTERY，商品列表:GOODS_LIST, 集卡:JK,计步签到:BBYL,线上跑:ONLINE_RUNNING</td>
</tr>
<tr>
<td style="text-align: left;">channel</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>分享渠道</td>
<td>微信好友WECHAT_FRIEND,太阳码SUN_CODE</td>
</tr>
<tr>
<td style="text-align: left;">outChannel</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>外部渠道</td>
<td>ZC1单聊:SINGLE_CHAT，ZC2群聊:GROUP_CHAT，ZC3朋友圈:WECHAT_MOMENT，ZC4老客建群:REGULAR_BUILD_GROUP，ZC5欢迎语:WELCOME_MESSAGE，ZC6宁导购:NDG，ZC7运动小程序:YD</td>
</tr>
<tr>
<td style="text-align: left;">pageId</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>官网装修页或内容页的页面ID（纯数字）</td>
<td>分享页面sharePageType=RENOVATION_PAGE或CONTENT_PAGE时必填</td>
</tr>
<tr>
<td style="text-align: left;">spuOuterId</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>官网商品的编码（例如：ASKR020-3 ）</td>
<td>分享页面为商详页sharePageType=GOODS时必填</td>
</tr>
<tr>
<td style="text-align: left;">materialInfo</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>素材信息</td>
<td>不限制输入内容，输入上限64字</td>
</tr>
<tr>
<td style="text-align: left;">goodsChannel</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>商品渠道类型</td>
<td>默认普通商品， 0-普通商品， 6-奥莱商品</td>
</tr>
<tr>
<td style="text-align: left;">width</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>太阳码宽度</td>
<td>默认430，二维码的宽度，单位 px，最小 280px，最大 1280px</td>
</tr>
<tr>
<td style="text-align: left;">shareParams</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>页面分享参数</td>
<td>后续新增的页面统一的页面分享参数, 当分享页面sharePageType=DRAW、LOTTERY、JK、ONLINE_RUNNING时传活动ID。当分享页面sharePageType=GOODS_LIST时，goodsChannel和keyword(keyword可以为空)</td>
</tr>
<tr>
<td style="text-align: left;">needWxLink</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">boolean</td>
<td>是否需要微信短链</td>
<td>不传默认值false</td>
</tr>
<tr>
<td style="text-align: left;">bizType</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>业务类型</td>
<td>业务类型 NORMAL_SAAS:官网(默认),OUTLETS:奥莱</td>
</tr>
<tr>
<td style="text-align: left;">taskId</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>任务Id</td>
<td>任务Id ,长度最多64位</td>
</tr>
<tr>
<td style="text-align: left;">groupId</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>群ID</td>
<td>群ID ,长度最多64位</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code>{
&quot;data&quot;: {
&quot;employeeId&quot;: &quot;01222210&quot;,
&quot;shareTime&quot;: &quot;1677679356972&quot;,
&quot;source&quot;: &quot;小程序&quot;,
&quot;channel&quot;: &quot;太阳码&quot;,
&quot;sharePageType&quot;: &quot;商详页&quot;,
&quot;pageId&quot;: null,
&quot;pageName&quot;: null,
&quot;goodsType&quot;: &quot;官网商品&quot;,
&quot;spuOuterId&quot;: &quot;KYYR010-3&quot;,
&quot;shareSign&quot;: &quot;MjU1NzIyNzAzNzZ8MjU2OTk2Nw==&quot;,
&quot;shareLink&quot;: &quot;supermarket/pages/home/share-land/index?toPath=%2Fgoods%2Fdetail&amp;toParams=cps%3DMINI_PROGRAM.poster.1677679356972.120004692824771.1%26from%3Dbutton%26isGuide%3Dtrue%26needCpsBind%3Dtrue%26shareSource%3Dminiprogram%26spuId%3D12660532&quot;,
&quot;shareSunCode&quot;: &quot;https://lining-data-qa-1302115263.cos.ap-guangzhou.myqcloud.com/upload/zhichi/distribute/20230301/1677679357919.png&quot;,
&quot;outChannel&quot;: &quot;SINGLE_CHAT&quot;,
&quot;materialInfo&quot;: &quot;32175&quot;,
&quot;shortLink&quot;: &quot;#小程序://百搭衣橱/8ML23CDVQFzU08C&quot;
},
&quot;code&quot;: &quot;Success&quot;,
&quot;msg&quot;: &quot;&quot;,
&quot;errorMsg&quot;: &quot;&quot;,
&quot;traceId&quot;: &quot;274d65b622a7ecb0&quot;,
&quot;requestId&quot;: &quot;&quot;,
&quot;rt&quot;: 0,
&quot;clientIp&quot;: null,
&quot;success&quot;: true
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">String</td>
<td>状态码</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">String</td>
<td>响应信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">Array</td>
<td>分享信息</td>
</tr>
<tr>
<td style="text-align: left;">data.employeeId</td>
<td style="text-align: left;">String</td>
<td>员工号</td>
</tr>
<tr>
<td style="text-align: left;">data.shareTime</td>
<td style="text-align: left;">String</td>
<td>分享时间</td>
<td>时间戳</td>
</tr>
<tr>
<td style="text-align: left;">data.source</td>
<td style="text-align: left;">String</td>
<td>分享平台</td>
<td>固定：小程序</td>
</tr>
<tr>
<td style="text-align: left;">data.channel</td>
<td style="text-align: left;">String</td>
<td>分享渠道</td>
<td>微信好友,太阳码</td>
</tr>
<tr>
<td style="text-align: left;">data.sharePageType</td>
<td style="text-align: left;">String</td>
<td>分享页面</td>
<td>小程序首页,装修页,内容页面,商详页,我的门店</td>
</tr>
<tr>
<td style="text-align: left;">data.pageId</td>
<td style="text-align: left;">String</td>
<td>分享页面ID</td>
<td>内容页和装修页返回</td>
</tr>
<tr>
<td style="text-align: left;">data.pageName</td>
<td style="text-align: left;">String</td>
<td>分享页面名称</td>
<td>内容页和装修页返回</td>
</tr>
<tr>
<td style="text-align: left;">data.goodsType</td>
<td style="text-align: left;">String</td>
<td>商品类型</td>
<td>分享页面类型为商详页返回：官网商品</td>
</tr>
<tr>
<td style="text-align: left;">data.spuOuterId</td>
<td style="text-align: left;">String</td>
<td>分享商品编码</td>
<td>分享页面类型为商详页返回</td>
</tr>
<tr>
<td style="text-align: left;">data.materialInfo</td>
<td style="text-align: left;">String</td>
<td>素材信息</td>
<td>输入的内容信息</td>
</tr>
<tr>
<td style="text-align: left;">data.shortLink</td>
<td style="text-align: left;">String</td>
<td>微信短链接</td>
<td>#小程序://百搭衣橱/8ML23CDVQFzU08C</td>
</tr>
<tr>
<td style="text-align: left;">data.shareSign</td>
<td style="text-align: left;">String</td>
<td>链接ID</td>
<td>MzIwMDMwOTY4fDIxNzYxNjE5</td>
</tr>
<tr>
<td style="text-align: left;">data.shareLink</td>
<td style="text-align: left;">String</td>
<td>分享链接 【微信短链接】模式下为空</td>
<td>/supermarket/pages/home/share-land/index?toPath=%2Fgoods%2Fdetail&toParams=cps%3Dmp.friend.1676533117003.120007304674537.1%26from%3Dbutton%26isGuide%3Dtrue%26needCpsBind%3Dtrue%26shareSource%3Dminiprogram%26spuId%3D7930838</td>
</tr>
<tr>
<td style="text-align: left;">data.shareSunCode</td>
<td style="text-align: left;">String</td>
<td>太阳码链接 【微信短链接】模式下为空</td>
<td>cos下载链接地址</td>
</tr>
<tr>
<td style="text-align: left;">data.outChannel</td>
<td style="text-align: left;">String</td>
<td>外部渠道</td>
<td>ZC1单聊，ZC2群聊，ZC3朋友圈，ZC4老客建群，ZC5欢迎语</td>
</tr>
</tbody>
</table>
<h5>错误码描述</h5>
<table>
<thead>
<tr>
<th>错误码</th>
<th>错误解释</th>
</tr>
</thead>
<tbody>
<tr>
<td>REQUEST_ERROR</td>
<td>入参异常</td>
</tr>
<tr>
<td>OUTLETS_AUTH_FAIL</td>
<td>抱歉，您无奥莱商品购买权限,请联系导购~</td>
</tr>
<tr>
<td>GATE_CALL_TIME_OUT</td>
<td>服务器开小差,请稍后重试 （一般服务间调用超时，如查询es）</td>
</tr>
<tr>
<td>UNSPECIFIED</td>
<td>网络异常，请稍后再试 （一般是微信测生成太阳码超时）</td>
</tr>
<tr>
<td>ZHICHI_EMPLOYEE_NOT_EXIST</td>
<td>会员不存在</td>
</tr>
<tr>
<td>ZHICHI_SPU_NOT_EXIST</td>
<td>商品不存在</td>
</tr>
<tr>
<td>ZHICHI_CONTENT_PAGE_ID_NOT_EXIST</td>
<td>内容页页面不存在</td>
</tr>
<tr>
<td>FAIL</td>
<td>失败 (创建)</td>
</tr>
<tr>
<td>LIMITED</td>
<td>接口被限流</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>