1 平台介绍

数字招行开放平台（以下简称 Open API平台）能够发布、分发、管理、监控、推广、共享企业API资源，保护招行API、应用程序和用户。Open API平台生产者门户可以创建、配置和托管RESTFUL API，从而让消费者端的应用程序可以轻松访问后端API。

我们有安全稳定的API产品，覆盖测试、验收、投产全流程的技术支持，面向丰富的业务场景提供的解决方案，提供精准检索的海量在线文档，致力于打造最佳数字招行开放平台，助力客户实现数字化转型。 安全、稳定、便捷、创新，超越客户的预期是我们永恒的追求。

目前，Open API平台包括三个站点：消费者门户、生产者门户和运营门户。

消费者门户：用于用户注册、订阅API、创建appid/appsecret。

生产者门户：用于发布API，查看已发布API列表及API订阅、调用等信息。

运营门户：用于为运营管理人员提供服务，包含各类监控和管理功能。

环境地址

消费者在正式调用API服务之前，一般需要先要在测试（沙盒）环境进行调用测试和业务验证。消费者用户（外部商户）可通过消费者门户获取接入凭证（appid和appsecret），通过API调用地址访问招行服务。

生产环境地址如下：

地址

说明

https://openapi.cmbchina.com

门户访问地址。

https://api.cmbchina.com（生产环境）

https://api.cmburl.cn:8065（沙盒环境）

API调用地址。

名词解释

1、API & API产品

API在这里指的是 HTTP API，包括基本信息，请求参数等，并应尽可能遵循 RESTful 设计规范。招行业务团队将自身的服务能力封装成 API，并通过 Open API 平台开放给行外用户调用。

API产品指的是同一种业务 API 方法的集合，一个产品包含多个 API 方法。生产者以 API产品为单位，管理 API产品中的所有API。

2、应用

应用是一个虚拟的概念，API 消费者需要创建一个应用，然后将需要使用的 API 产品关联到这个应用才能使用。 一个应用可以关联多个 API 产品，一个 API 产品可以被多个应用使用，一个用户可以创建多个应用。

3、密钥

每个应用都可以创建多组密钥，每组密钥作用相同，都可以在消费者程序中使用，多组密钥的意义可以让用户禁用旧的密钥，启用新的密钥，进行密钥的轮换。 密钥由 appid 和 appsecret 组成，用于网关验证消费者请求，保证 api 调用的安全性。注意， appsecret 仅用于生成签名，不要在调用中传输。

4、密钥对

本平台的密钥对是指非对称签名密钥对，包括公钥和私钥。其中，私钥由用户保管，用于生成签名；公钥需上传至平台，用于平台验证签名。用户可以上传多个公钥，但是一个 appid 只能绑定一个公钥。