第一步:发布API到门户
在项目中上线的API需要发布到API门户中,才可以开放给API消费者(合作伙伴)进行授权和调用。所以,首先要先在管理平台中创建API门户。
1. 创建门户
在侧边栏中点击 API门户管理,之后点击新建API门户按钮。
创建API门户时需要填写三部分信息,接下来我们会逐一介绍主要内容的作用和功能
API门户信息
环境: 门户仅可发布该环境中部署的API资源。一个门户仅可绑定一个环境。
门户的名称: 用于在管理平台门户列表中快速识别一个门户。
唯一路径标识: 发布后API调用URL的一部分,便于网关区分API调用所属门户。该标识只能在创建门户时进行设置,门户创建成功之后 将不能修改。如果用户不指定这个标识,系统会自动生成一字符串作为门户标识,比如:
por-1001
。项目: 门户仅可发布此处选择的项目中部署的API。注意:只有部署到所选环境中的项目才能被选中。
Logo: 该门户对外展示的Logo
合作伙伴管理:
合作伙伴是指可以登录到该门户的用户,可以在【合作伙伴管理】中创建。在【门户管理】中管理员可以向门户中绑定合作伙伴,并针对绑定的合作伙伴进行单独的API授权。
注意:未绑定的合作伙伴登录门户后只能查看和调用匿名授权的API资源。
API资源管理:
待发布的API需要先添加到门户的API资源中,才能进行后续的授权。可添加到资源池中的API为门户所选项目部署到所选环境中的API。
在API资源中可以看到一个叫做**分组**的概念,方便在门户中按照业务逻辑对API资源进行分组。您可以创建、删除、更名以及改变该分组的顺序;通过将API资源放入到不同的分组中,门户保存后,门户上的API资源将会按照您所创建的分组形式展现出来。
点击保存并发布,此时可以在门户列表页看到这个门户的信息。
2. API预授权
门户创建成功后,管理员可以针对API资源中的API进行预授权。
点击 授权 操作,进入门户预授权的页面。通过预授权,我们可以将API资源按照需求分配给不同的合作伙伴。
预授权对象包含:匿名用户、 绑定的合作伙伴
- 匿名用户为未登录的用户或未绑定的合作伙伴。
授权内容包含:可见性、 可调用性、粒度授权(访问频次、黑白名单)
如果将某API设置为对 X 合作伙伴可见,但是不可调用。那么 X 合作伙伴登录门户后,还可以主动申请该 API 的调用权限。管理员可以在门户的授权页面管理合作伙伴的授权申请。
上述步骤完成了API门户的创建和API的发布流程,下一步,我们将介绍合作伙伴如果通过API门户查看以及调用API资源。