基本规则
<h3>基本信息</h3>
<p><strong>所有的API请求必须使用HTTPS。</strong></p>
<p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=84377bbf79ab2ba35b57c567688253d8&amp;file=file.png" alt="" />请求时不应忽略服务器证书验证的错误,避免被恶意劫持</p>
<h3>数据格式</h3>
<p><strong>参数传输通过JSON方式</strong></p>
<pre><code>Content-Type: application/json</code></pre>
<h3>字符集</h3>
<pre><code>UTF-8</code></pre>
<h3>日期格式</h3>
<pre><code>yyyy-MM-dd
yyyy-MM-dd HH:mm:ss</code></pre>
<h3>请求参数示例</h3>
<pre><code>reqmsg明文:
{
&quot;orgCode&quot;: &quot;xxx&quot;,
&quot;orderNo&quot;: &quot;xxxx&quot;,
&quot;sign&quot;: &quot;10AD305A511101E9EC1D899B6EEF4102&quot;
}
请求微保的body数据
{
&quot;customerNo&quot;: &quot;微保分配给商户的商户号&quot;,
&quot;reqmsg&quot;: &quot;通过微保分配的公钥加密后的业务数据&quot;
}
</code></pre>
<h3>应答字段描述</h3>
<pre><code>微保响应的body数据
{
&quot;code&quot;: &quot;见错误码&quot;,
&quot;msg&quot;: &quot;见错误码&quot;,
&quot;data&quot;: &quot;加密后业务数据&quot;
}
data明文:(通过微保分配的公钥解密后)
{
&quot;orgCode&quot;: &quot;xxx&quot;,
&quot;orderNo&quot;: &quot;xxxx&quot;,
&quot;sign&quot;: &quot;10AD305A511101E9EC1D899B6EEF4102&quot;
}
</code></pre>
<h3>API文档约定</h3>
<h4>请求报文约定</h4>
<p>API接口中只存在业务字段reqmsg中的详细字段描述,不再包含外层customerNo、reqmsg描述</p>
<pre><code>reqmsg明文:
{
&quot;orgCode&quot;: &quot;xxx&quot;,
&quot;orderNo&quot;: &quot;xxxx&quot;,
&quot;sign&quot;: &quot;10AD305A511101E9EC1D899B6EEF4102&quot;
}
</code></pre>
<h4>响应报文约定</h4>
<p>API接口中只存在业务字段data中的详细字段描述,不再包含外层code、msg、data结构描述</p>
<pre><code>data明文:(通过微保分配的公钥解密后)
{
&quot;orgCode&quot;: &quot;xxx&quot;,
&quot;orderNo&quot;: &quot;xxxx&quot;,
&quot;sign&quot;: &quot;10AD305A511101E9EC1D899B6EEF4102&quot;
}
</code></pre>