赠人玫瑰，手留余香。
有些AMPP应用在建立的时候需要提供API Key，比如Virtual K-Frame， GV.UI, AMPP Control, AMPP Tally Service, AMPP Stream Deck, AMPP MIDI等等，这篇文章主要说如何获得或者生成所需的API KEY
有两种方法可以获取API KEY
- 向NOC要
- 自己生成API KEY, 前提是知道使用API KEY的具体设置参数
本文主要讲述如何自己生成API KEY
在Identity Management中使用Generate API Key栏生成
用亚太生产平台举例说明如何在Identity Management中使用Generate API Key栏生成AMPP Control的API KEY
- 使用Chrome访问AMPP亚太生产平台https://apac1.gvampp.com
- 输入用户名密码登录到AMPP账户
- 进入Platform Tools->Identity Management界面
- 选择Generate API Key栏目,然后点击AMPP Control
- 在框中填入名称和位置点击OK创建。名称和位置需要包括足够鉴别这个KEY的相关信息
- 复制窗口中的API Key即可
在Identity Management中Applications栏下新建API KEY
刚才的方法相对比较简单，Applications栏下新建需要掌握的背景更多些。
用刚才我们创建的API KEY为例，其实我们可以从Applications中找到
鼠标右键点击这行并在弹出的菜单中选择Edit，可以看到刚刚建立的API KEY的参数
这里可以看到除了刚刚我们填写的Name和Location之外，Type实际是我们点击的按键的值
还有3个特别重要的参数： Role， Allowed Scopes，Redirect Uris，如果知道这些参数，那我们也可以从Platform Tools->Identity Management界面applications栏目进入应用ID管理界面或者直接访问https://apac1.gvampp.com/management/identity/applications 再通过点右上角+号新建API KEY
实际从这里建立和刚才从Generate API Key栏建立一样，同样填写Name和Location后按照下面给出的常见的Type填写和选择正确的Role，Allowed Scopes和Redirect Uris就可以
| Use Case | Application | Grant Type | Role | Scopes | Redirect Uris |
|---|---|---|---|---|---|
| AMPP Control | AMPP Control | ImplicitAndClientCredentials | Platform, Platform.readonly, Cluster, Cluster.readonly | ||
| AMPP Control MIDI Setup | AMPP Control MIDI Setup | ImplicitAndClientCredentials | cluster.agent | Platform, Platform.readonly, Cluster, Cluster.readonly | |
| AMPP SPC | AMPP SPC | ImplicitAndClientCredentials | cluster.agent | platform, platform.readonly, cluster, cluster.readonly | |
| AMPP LiveTouch | AMPP LiveTouch | ImplicitAndClientCredentials | Platform, Platform.readonly, Cluster, Cluster.readonly | ||
| GV.UI | GV.UI | HybridAndClientCredentials | platform, platform.readonly, cluster, cluster.readonly | http://localhost:8010 | |
| Midi Mapper | Midi Mapper | ImplicitAndClientCredentials | Platform, Platform.readonly, Cluster.readonly | ||
| Stream Deck | Stream Deck | ImplicitAndClientCredentials | Platform, Platform.readonly, Cluster, Cluster.readonly | ||
| Tally | Tally Service | ClientCredentials | cluster, cluster.readonly, platform, platform.readonly | ||
| AMPP C2AMPP | C2AMPP | ClientCredentials | cluster.readonly, platform, platform.readonly |
Grant Type
Role
Allowed Scopes
Redirect Uris
GV.UI的API KEY需要设置Redirect Uris到http://localhost:8010
Comment (1) on "如何为AMPP应用生成所需的API KEY"
Comments are closed.