自定义接口

概述

支持游戏自助配置个性化GM功能,以响应不同游戏的设计及管理需求。

使用前提

于“星云开放平台 → 游戏中心 → 选择游戏 → 对接中心 → GM接口管理 → 自定义接口”,正确配置并上线接口。

添加/修改自定义接口

  • 点击“添加/修改自定义接口”进入配置页面。
  • 分组,用于GM系统中自定义功能的子菜单显示:若部分自定义接口期望归集于同一菜单显示,则选择同一分组即可;例,角色补偿、全服补偿、补偿记录查询 计划统一归类为 奖励补偿,则创建“奖励补偿”分组并将这三个接口均选中此分组即可。
  • 目前支持的接口类型分为“查询”、“操作”两大类:
    1. 例,补偿记录查询 属于“查询”,角色补偿、全服补偿 属于“操作”。
    2. 查询,将默认配置“per_page”、“page”参数,用于支撑查询结果的翻页功能,其余参数将作为查询条件。
  • 参数配置

    1. 可通过“新增参数”自助添加此接口所需的参数,也可通过上下箭头调整参数于GM系统对应功能页的显示顺序。

    2. 每个参数需设置其在GM系统对应功能页如何展示及交互,包含:参数名称、参数描述、是否必填、参数类型、控件类型。

    3. 若存在多个参数需至少必填一项才可提交的情况,可通过“提交设置”设置。

    4. 游戏服、渠道参数

      • 若需使用星云GM系统“游戏服管理”维护的游戏服信息,枚举获取地址可填入__NEBULA_SERVER__
      • 若需使用星云对接中心“渠道配置”维护的渠道信息,枚举获取地址可填入__NEBULA_CHANNEL__
    5. 请求参数的说明,可以参考GM接口对接文档

    GM接口配置_列表_自定义接口

    GM接口配置_自定义接口表单

分组管理

  • 分组,支持 添加、修改、删除、旗下接口转组;其中,预置的“默认”分组不支持删除(但支持改名)。
  • 在“分组管理”列表中未删除且旗下有接口的分组,将在“星云开放平台 → 企业管理 → 成员与权限 → 用户组管理” 中作为GM系统的“自定义功能权限”供用户组授权及对应用户组菜单显示。

GM接口配置_分组管

GM系统_用户组授权_自定义功能权限

功能使用

已配置并上线的自定义接口,当权限分配完成后,将显示在“星云开放平台 → 游戏中心 → 选择游戏 → GM系统 → 自定义功能”。
GM系统_自定义功能