api使用

功能概述

主要给租户应用中对申请订阅的api进行使用及通过提供的APIRequestSDK使用操作说明

使用租户管理员登录控制台,在应用服务管理中,可查看已订阅成功的api秘钥

平台应用ide中调用api

  1. 在IDE中添加api
  2. 在打开的api列表中选择引用
  3. 添加后在API中会显示添加的服务,展开下拉箭头,会显示出当前服务下提供的接口
  4. 选择服务下的接口添加到页面上,如图为shspro18api服务下的test1接口服务

  5. 组件有提供设置发送数据、请求头基础属性

  6. 组件提供发送请求操作,如图在按钮事件中发送请求并设置请求参数

  1. 组件提供请求前、请求成功、请求失败事件,如图在请求成功中返回接口数据
     onApiRequest0Success = (event) => {
         alert("返回结果:"+JSON.stringify(event.response.data));
     }
    
  2. 如还要添加其他api,则点击+打开添加列表,选择api引用即可
  3. 要在IDE里正常调用运行,需要对调用api添加秘钥环境变量配置,切换到代码页签,打开model/service/main/deploy/dev.def.xml文件,增加api秘钥环境变量配置,多个就增加多个api密钥环境变量配置,配置内容如下:
    <property  name="API_488018A5_9FCE_88F5_6A0E_BE7D501239EB_CONFIG" env="API_488018A5_9FCE_88F5_6A0E_BE7D501239EB_CONFIG" value="eyJhcGlDb2RlIjoiNDg4MDE4YTUtOWZjZS04OGY1LTZhMGUtYmU3ZDUwMTIzOWViIiwiYXV0aGVudGljYXRpb24iOiJCQVNJQyIsImNsaWVudElkIjoiYTMwMWZiMzUtZWFhMC00NWIxLTk4M2EtMzliMTI2Y2FmNmQ2Iiwia2V5IjoiMDMzM2M1NzgtYWQ1NC00NmJhLTk2NmUtMzU4ZGZjNzMwMWE1IiwicGFzc3dvcmQiOiI4YTcyZDFjYS04OWMzLTQ0MDUtYWFlYy01NjdlOGFlZmEyOTMiLCJzZWNyZXQiOiIxZjZkMmJjNi1iNmVlLTRiMTMtYTY4ZC1hZDA5OGY1Y2JjNDkiLCJzZXJ2ZXJVcmwiOiJodHRwczovL2VudHJ5ZHB0MXRlbmFudDAtdmlwLmgueGNhYXMubmV0L2FwaXMvc3AxMjA0IiwidXNlcm5hbWUiOiJhMzAxZmIzNS1lYWEwLTQ1YjEtOTgzYS0zOWIxMjZjYWY2ZDYifQ" readonly="true">
    <label label = "API_488018A5_9FCE_88F5_6A0E_BE7D501239EB_CONFIG"/>
    </property>
    
  4. 配置完成后,IDE高级下重启制作台
  5. 如没配置api密钥环境变量,运行调用则会报如图错误

生产部署应用调用api

  1. 对于发布到生产环境需要调用api的应用,需要在应用服务管理中,对该应用进行环境变量配置
  2. 在配置页面的环境变量中,选择用户自定义
  3. 在参数配置中添加变量名及值即可

平台外调用

平台外调用通过平台提供的apiRequest工具类来调用牛刀平台发布的API,具体使用参考牛刀平台APIRequest SDK使用说明

results matching ""

    No results matching ""