概述
API秘钥是访问Oceanpayment API所需的最基本凭据。这些凭据充当Oceanpayment应用的用户名和密码,Oceanpayment API会使用它们来识别请求来自哪个账户。 为了使您的应用程序能够与Oceanpayment通信,必须使用秘钥组合来对其进行身份验证。
注意
- 当您获取秘钥时,需要完成您的企业账户注册认证。
- 接受付款、OPCard、OPCCOUNT每个场景需要的配置信息不同,请根据不同场景功能进行申请。
接受付款
配置信息
account:Oceanpayment账户号。terminal:Oceanpayment终端号,区分不同的支付通道或支付场景。secureCode:Oceanpayment安全码,用于加密signValue字段使用。为了接口安全性,请求时不能提交此安全码信息,它只参与加密。key:Oceanpayment公钥,用来加密卡信息。只有信用卡支付嵌入式、服务器对服务器集成用到。
信息
👉快速掌握收款配置信息的使用方法。
环境
- 沙盒环境:请联系Oceanpayment技术支持techservice@oceanpayment.com.cn开通。
- 生产环境:完成企业账户注册认证后,在账户后台 > 开发者模块中查看对应的账户配置信息。
OPCard
配置信息
app_key:企业认证成功后分配的开发者ID。app_secret:企业认证成功后分配的对应开发者ID的秘钥。
环境
完成IAM注册后,登录IAM;
- 沙盒环境:
- 账号完成企业认证后将自动开通沙盒工具,您也可以直接申请【开通沙盒工具】提前开通沙盒环境。
- 企业认证通过或手动申请通过审核,沙盒完成开通,访问沙盒环境地址进行登录,可重置秘钥。
- 生产环境:
- 完成企业账户注册认证后,在开发者模块中查看对应的账户配置信息。
- 生产环境密钥查看路径:IAM > 首页 > 开发者控制台 > Developer > 密钥管理。
身份验证和安全
App Key 和App Secret:用于服务器根据客户端凭证颁发令牌(Access Token)的场景,可以向服务器验证自身身份并获取访问令牌,然后使用该访问令牌访问受保护的资源。
使用流程
- 身份验证:应用程序在调用OPCard API之前,需要将App Key和App Secret与API请求一起发送。
- 令牌生成:Oceanpayment接收App Key和App Secret生成身份验证令牌。
- 权限验证:应用程序在后续的API调用中,使用令牌进行身份验证和权限验证,从而访问API。
创建令牌
curl -X POST 'https://checkout-s.oceanpayment.com/open-api/v1/oauth/token/create'
-H 'Content-Type: application/json'
-D '{"app_key":"7FWGJDQYQZFCPXT7QL", "app_secret":"LQ7qF1UM7x3BfyfYTVa24qci53uPsNGJmrlC2NEJQq8BLszrrsRdIJb04teTgAx9yV5ncXPOjpYOYC0rZ6BkWP7yesQD0Dla3hRJ8WCd6880qaJeZM6idAv0WZYnY5s1"}'
更新令牌
为什么需要更新令牌?以固定间隔轮换应用程序令牌有几个原因:
- 替换已配置为自动过期的令牌;
- 限制任何受损令牌的影响;
- 携带用于请求接口的通行令牌,有效期为60分钟。
使用创建令牌生成的refresh_token进行刷新。
curl -X POST 'https://checkout-s.oceanpayment.com/open-api/v1/oauth/token/refresh'
-H 'Content-Type: application/json'
-D '{"refresh_token":"eyJhbGciOiJIUzUxMiJ9.eyJvcF9pZCI6IjI1MDAwMDEiLCJzaWduX2RhdGUiOjE3NTM5NTgwNTV9.__P-t3t24aB5ptYVfH6dkOD7m7TOtzBJ0Ua30CC5QNFTlI1br3DaLykW6ggU5pyp3ztaW4aTESZKcSt59WH-SA"}'
OPCCOUNT
配置信息
Opccount-No:OPCCOUNT账号。Va-Code:商户唯一值,由Oceanpayment提供。
环境
- 沙盒环境:请联系Oceanpayment技术支持开通。
- 生产环境:完成企业账户注册认证后,Oceanpayment技术支持提供配置信息。