发起请求
对币趣支付 REST API 的请求遵循 RESTful 约定,针对各种资源的交互均使用标准的 HTTP 方法和状态码,并返回 JSON 格式的响应。通过使用币趣支付官方 SDK,可以极大程度地简化这一交互过程。
每个请求的 HTTP 标头中必须包含以下基础声明:
Content-Type: application/json
API 鉴权机制与请求头
在使用币趣支付需要进行身份验证的接口时(大多数核心业务接口均在此列),您的 API 请求必须根据不同的鉴权方式,携带并附加特定的签名标头。
目前币趣支付支持以下两种主流的 API 鉴权签名方式,您可根据业务的安全侧重选择其一:
方式一:使用 API Key 进行鉴权(适合常规对接,集成轻量化)
在使用 API Key 鉴权时,您的 HTTP Header 必须包含:
X-Api-Key:在商户后台为您分配的 API Key 值。X-Signature:使用与该 API Key 匹配的Secret Key对待签名数据进行 HMAC-SHA512 加密,得到的 16进制字符串 (Hex) 签名结果。
方式二:使用商户 API 证书进行鉴权(适合极高安全级别核心业务)
在使用非对称加密证书进行鉴权时,您的 HTTP Header 必须包含:
X-Identity:平台颁发的商户 API 公钥证书内容(需去除换行符)。X-Signature:使用对应的商户私钥(.key文件)对待签名数据进行 SHA256 with RSA 签名,得到的 Base64 编码 签名结果。
签名您的请求与详细指南
关于 “如何构建待签名字符串” 、加密算法如何处理、以及具体的签名拼接样例。无论您选择 API Key 是 商户 API 证书 ,都务必根据下方指南仔细比对算法与数据格式:
发起您的第一个请求
准备好鉴权标头后,向资源 URI 发送您的 HTTP 请求。
例如,创建一个 Invoice (收款单),您可能会发送:
http
POST /v2/invoices HTTP/1.1
Host: openapi.basicex.com
Content-Type: application/json
X-Api-Key: YOUR_API_KEY
X-Signature: YOUR_HMAC_HEX_SIGNATURE
{
"orderNo": "2023082300001",
...
}有关特定资源 URL 和参数的更多信息,请访问具体的业务资源文档页面。