守兔开放平台api

供合作方调用


回调api

<p>接入方接收回调</p> <h5>简要描述</h5> <ul> <li>订单状态发生变更时,通知接入方。</li> <li>接入方需保证回调地址稳定可用、避免订单状态不一致产生问题。</li> <li>为了避免因为特殊情况导致没有回调的情况出现,建议跟订单查询接口配套使用</li> </ul> <h5>回调URL</h5> <ul> <li>notifyUrl【下单时传递的url】</li> </ul> <h5>回调方式</h5> <ul> <li>POST </li> </ul> <h5>回调参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>签名,接入方需校验签名是否有效。签名规则与下单相同。</td> </tr> <tr> <td style="text-align: left;">appKey</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>接入方key (推广位)</td> </tr> <tr> <td style="text-align: left;">time</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>时间戳</td> </tr> <tr> <td style="text-align: left;">eventName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>订单状态发生变更时的事件如: ORDER_CLOSE</td> </tr> <tr> <td style="text-align: left;">thirdOrderId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>接入方下单时的订单号</td> </tr> <tr> <td style="text-align: left;">notifyUrl</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>回调地址,各个场景发生时,将通过此地址通知接入方</td> </tr> <tr> <td style="text-align: left;">orderPrice</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>api下单成本价(竞价结束回调通知返回:WAIT_TICKET场景)</td> </tr> <tr> <td style="text-align: left;">closeCause</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>如果事件为订单关闭 ORDER_CLOSE 则有此字段</td> </tr> <tr> <td style="text-align: left;">realSeat</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>实际出票座位,仅供参考,可能与票不一样,也可能为空,一般当实际座位与下单座位不一样时会有。</td> </tr> <tr> <td style="text-align: left;">ticketCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>取票码字符串如: &quot;[\&quot;123123\&quot;,\&quot;4564357\&quot;]&quot; 直接用json解析可得到数组,如取票失败则用使用原始截图</td> </tr> <tr> <td style="text-align: left;">ticketImage</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>取票码原始截图如: &quot;[\&quot;http:\\/\\/shoutudyp.oss-cn-shenzhen.aliyuncs.com\\/b768007aa9071eba3e3018a27dcc47c0.png\&quot;,\&quot;http:\\/\\/shoutudyp.oss-cn-shenzhen.aliyuncs.com\\/f9774915e35fae41ae96ebf288477394.jpg\&quot;]&quot; 直接用json解析可得到数组</td> </tr> </tbody> </table> <h2>事件解释</h2> <table> <thead> <tr> <th style="text-align: left;">事件名</th> <th style="text-align: left;">解释</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">ORDER_CLOSE</td> <td style="text-align: left;">订单因为某种原因,关闭,或出票失败,或场次取消等,通知接入方。此时接入方应开启退款流程</td> </tr> <tr> <td style="text-align: left;">ORDER_FINISH</td> <td style="text-align: left;">当订单正常处理完毕后回调。 表明此订单处理结束,包括已结算</td> </tr> <tr> <td style="text-align: left;">WAIT_TICKET</td> <td style="text-align: left;">订单竞价结束,正在等待出票时,回调</td> </tr> <tr> <td style="text-align: left;">TICKET_SUCCESS</td> <td style="text-align: left;">订单出票成功时候回调, 参数包含出票相关信息。</td> </tr> <tr> <td style="text-align: left;">TICKET_SYNC</td> <td style="text-align: left;">当取票码出现意外情况,需要修改时,回调第三方。 参数与TICKET_SUCCESS一致。</td> </tr> <tr> <td style="text-align: left;">INQUIRY_BACK</td> <td style="text-align: left;">调用创建询价结果后,返回对应询价结果</td> </tr> </tbody> </table> <h5>接入方处理完毕后,需返回</h5> <pre><code>{ &amp;quot;success&amp;quot;: true, &amp;quot;message&amp;quot;: &amp;quot;请求成功&amp;quot;, &amp;quot;code&amp;quot;: 200 } </code></pre> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML