【顺丰快递管家】通用接口文档


1.员工身份有效性校验接口

<h3>功能描述</h3> <ul> <li>该接口用于:顺丰快递管家校验客户方的员工身份的有效性(如是否有离职等情况)。</li> <li>客户需提供一个符合以下规范的HTTP/HTTPS URL,以接收顺丰快递管家通用接口的信息: 1.路由信息为JSON格式,通过HTTP/HTTPS POST方式推送给客户;</li> </ul> <pre><code>注:1.此接口建议客户方系统做验签功能,规避被恶意攻击的风险; 2.测试环境如需测试该接口,请将测试环境需校验信息发给顺丰研发接口人,便于其生成相关测试数据; 3.对于同一条信息,推送成功则不重复推送,推送失败则会再次推送,失败3次后不再推送;</code></pre> <h3>接口定义</h3> <table> <thead> <tr> <th style="text-align: center;">服务名称</th> <th style="text-align: center;">批量交易</th> <th style="text-align: center;">接口类型</th> <th style="text-align: center;">接口uri</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">员工身份有效性校验接口</td> <td style="text-align: center;">支持</td> <td style="text-align: center;">推送/POST</td> <td style="text-align: center;">客户方提供</td> </tr> </tbody> </table> <h3>元素&lt;请求&gt;</h3> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">verifyType</td> <td style="text-align: center;">Number(2)</td> <td style="text-align: center;">是</td> <td style="text-align: left;">校验类型:1-手机号;2-邮箱;3-第三方平台用户ID;</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">verifyList</td> <td style="text-align: center;">List&lt;String&gt;</td> <td style="text-align: center;">是</td> <td style="text-align: left;">校验数据列表。List形式,整体加密,加密方式详情请见《接入前必看-3.3Des加解密密工具类》。</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</h3> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">String(10)</td> <td style="text-align: center;">是</td> <td style="text-align: left;">状态:ok-成功;fail-失败。失败会重推两次,共推送三次,全部返回fail则不再推送。</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">否</td> <td style="text-align: left;">错误信息</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">List&lt;String&gt;</td> <td style="text-align: center;">否</td> <td style="text-align: left;">无效数据(如离职员工数据)集合。List形式,整体加密,加密方式详情请见《接入前必看-3.3Des加解密密工具类》。仅返回无效数据,有效数据(如在职员工数据)切勿返回,返回数据类型同请求类型(如请求时类型是手机号,则返回类型需同为手机号)</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;verifyType&amp;quot;: 1, &amp;quot;verifyList&amp;quot;: [ &amp;quot;18210350000&amp;quot;, &amp;quot;18210351111&amp;quot;, &amp;quot;18210352222&amp;quot; ] }</code></pre> </li> <li><strong>响应报文</strong> <ol> <li>成功报文(有无效数据的情况) <pre><code>{ &amp;quot;succ&amp;quot;:&amp;quot;ok&amp;quot;, &amp;quot;result&amp;quot;: [ &amp;quot;18210351111&amp;quot;, &amp;quot;18210352222&amp;quot; ] }</code></pre></li> <li>成功报文(无无效数据的情况) <pre><code>{ &amp;quot;succ&amp;quot;:&amp;quot;ok&amp;quot;, &amp;quot;result&amp;quot;: [] }</code></pre></li> <li>失败报文 <pre><code>{ &amp;quot;succ&amp;quot;:&amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;:&amp;quot;xxx&amp;quot; }</code></pre></li> </ol></li> </ul>

页面列表

ITEM_HTML