Skip to main content

第二步：在门户上访问API

登录状态​

合作伙伴在访问门户时会有以下3种状态:

  • 匿名访问：合作伙伴在不登录的情况下，可以看到该门户中 匿名 的API资源。
  • 登录访问（绑定合作伙伴）：非绑定的合作伙伴访问门户时，可以看到该门户中 匿名 的API资源。
  • 登录访问（绑定合作伙伴）：绑定的合作伙伴访问门户时，可以看到匿名及已授权的API资源。

初次登录​

合作伙伴首次创建后，系统会自动向您的邮箱中发送一份包含初始登录密码的邮件，请及时根据此邮件中的信息进行登录，并重置密码。

初始密码

API资源列表​

进入门户之后首先会看到门户的【API资源】列表，如果您为绑定合作伙伴，则还会看到更多门户功能。 您可以可以按照全部和分组的方式展示API资源，同时支持按资源名称搜索，以及按更新时间和调用次数排序。

portal01

API详情​

点击API资源可以查看API详情，详情页由三部分组成：

  • API的基本信息
  • API的调用方法
  • API的请求和响应定义

portal02

API授权申请​

在详细页中可能出现两个操作【申请】和【试一下】。当合作伙伴没有调用授权时（【显示【申请】按钮），需要先通过【申请】的方式获得对一个API的使用权。点击【申请】按钮之后，会要求合作伙伴填写申请原因，之后由管理平台的门户管理员决定是否通过这条申请。如果申请被通过，合作伙伴看到的按钮状态会变成【已授权】，否则按钮仍然为【申请】状态。合作伙伴也可以通过授权列表查看申请审批状态。

API调用测试​

用户可以使用【试一下】按钮用来进行API的测试，但调用非开启匿名授权的API前，需要先创建应用并分配API调用权限后才可以测试。 portal03

门户应用创建​

API的消费者通常通过合作伙伴创建的应用才能调用API（匿名调用除外）。合作伙伴可以点击应用列表来创建应用。 应用提供多种API认证方式，比如：APIKey、Basic。创建者需要根据业务需求选择其中一种认证方式： portal05

应用创建成功之后，可以在应用列表中看到它的相关信息。 portal04

点击应用的名字进入应用详情，这里展示了该应用可以调用的API。合作伙伴可以将已经获得授权的API增加到当前的应用里，也可以把当前应用中的一些API移除掉。

API粒度授权​

有一些API在发布到门户时设置了访问频次的限制，如果在实际使用过程中发现这个限制和实际业务需求不符，希望调整限制，可以通过粒度授权的方式申请调整。 portal06

门户统计​

合作伙伴可以在门户侧看到自己创建的应用的调用记录和相关统计数据。

注意：应用的创建者，仅能看到自己创建的应用的调用日志，看不到其他其他应用调用的日志。

调用统计

调用日志