喵提醒开发文档

喵提醒开发文档


获取参数

<p>[TOC]</p> <h5>功能</h5> <p>获取指定参数模板、指定提醒单的参数信息。</p> <ul> <li>若参数模板不存在,则返回参数信息为空;</li> <li>若提醒单不存在,或提醒单已绑定了其他参数模板,则返回指定参数模板的默认参数信息;</li> <li>若提醒单未绑定任何参数模板,则提醒单会自绑定指定参数模板,并返回参数模板的默认参数;</li> <li>若提醒单已绑定到指定的参数模板,且用户填写了参数内容,则返回用户填写的参数信息,否则,若用户未填写过参数内容,则返回的参数模板的默认参数;</li> <li>若用户填写的参数内容格式已过时,会先过滤掉用户的无效内容,与指定参数模板的默认参数合并后返回,例如:用户提交参数填写时是<code>{&amp;quot;key1&amp;quot;:520,&amp;quot;key2&amp;quot;:&amp;quot;hello&amp;quot;}</code>,但后续开发者把参数模板key1移除,保留key2,又增加的key3,新的参数模板的默认参数是<code>{&amp;quot;key2&amp;quot;:&amp;quot;hi&amp;quot;,&amp;quot;key3&amp;quot;:666}</code>,则API返回的过滤合并后的参数是<code>{&amp;quot;key2&amp;quot;:&amp;quot;hello&amp;quot;,&amp;quot;key3&amp;quot;:666}</code>。</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://miaotixing.com/rparam</code></li> <li><code>https://miaotixing.com/rparam</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET </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> <th style="text-align: left;">示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">rp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string(35位)</td> <td>参数模板码,指定获取哪个参数模板。</td> <td style="text-align: left;">rp-a695393d15b74f8d9a7dc461417e5c8d</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string(7位)</td> <td>喵码,指定获取哪个提醒单填写的参数。</td> <td style="text-align: left;">tDS0Se9</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>返回参数的数据格式,可选值<code>ini</code>,<code>json</code>,<code>xml</code>。默认json。</td> <td style="text-align: left;">xml</td> </tr> <tr> <td style="text-align: left;">encode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>返回参数的文字编码方式,可选值<code>utf8</code>,<code>gbk</code>,<code>gb</code>。默认utf8,其中gb兼容GB2312与GB18030两种编码。</td> <td style="text-align: left;">gbk</td> </tr> </tbody> </table> <h5>完整请求API地址示例</h5> <pre><code class="language-url">http://miaotixing.com/rparam?rp=rp-a695393d15b74f8d9a7dc461417e5c8d&amp;amp;code=tDS0Se9</code></pre> <h5>返回内容示例</h5> <p>type为<code>json</code>:</p> <pre><code class="language-json">{ &amp;quot;key1&amp;quot;: 1, &amp;quot;key2&amp;quot;: 5.3, &amp;quot;key3&amp;quot;: true, &amp;quot;key4&amp;quot;: &amp;quot;你好&amp;quot;, &amp;quot;submited_at&amp;quot;: 1721788956, }</code></pre> <p>type为<code>ini</code>:</p> <pre><code class="language-ini">key1=1 key2=5.3 key3=true key4=你好 submited_at=1721788956</code></pre> <p>type为<code>xml</code>:</p> <pre><code class="language-xml">&amp;lt;root&amp;gt; &amp;lt;field name=&amp;quot;key1&amp;quot;&amp;gt;1&amp;lt;/field&amp;gt; &amp;lt;field name=&amp;quot;key2&amp;quot;&amp;gt;5.3&amp;lt;/field&amp;gt; &amp;lt;field name=&amp;quot;key3&amp;quot;&amp;gt;true&amp;lt;/field&amp;gt; &amp;lt;field name=&amp;quot;key4&amp;quot;&amp;gt;你好&amp;lt;/field&amp;gt; &amp;lt;field name=&amp;quot;submited_at&amp;quot;&amp;gt;1721788956&amp;lt;/field&amp;gt; &amp;lt;/root&amp;gt;</code></pre> <p>返回参数固定带<code>submited_at</code>参数,该参数为最近一次用户填写参数的时间戳。开发者可以使用该时间戳判断有用户最近有没有更新过参数。</p> <h5>注意事项</h5> <ul> <li>请求API时,会生成不超过1分钟的缓存,缓存失效前用户更新的参数不会立即获取到,因此用户提交新参数后,API没能立即获得新参数信息是正常现象,等待缓存失效即可获取到最新内容。</li> </ul>

页面列表

ITEM_HTML