otago/ebs

EBS webservice

维护者

详细信息

github.com/otago/ebs

源代码

问题

安装次数: 5,701

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 5

分支: 1

开放问题: 0

类型:silverstripe-vendormodule

v5.1 2024-08-06 22:15 UTC

This package is auto-updated.

Last update: 2024-09-06 22:35:17 UTC


README

此扩展允许SilverStripe实例通过Web服务与Tribals EBS4学生管理系统进行通信。您可以自定义自己的只读Web服务查询,从而完全访问学生数据库。

Tribal logo

注意:Otago理工学院维护此模块,Tribal与此模块的维护无关。

安装

使用composer安装模块

$composer require otago/ebs

然后创建一个EBS用户

1. 打开'EBS Central'(客户端)

2. 访问用户管理

Access user management

3. 创建新角色

Create a role with at least these permissions

如果您没有执行此操作的权限,您可能需要寻求SMS管理员。

创建一个包含您的EBS Web服务用户详细信息的 app/_config/ebs.yml 文件

---
Name: EBSWebservice
---

OP\EBSCheckInstance:
    prod: https://ebs-live.organisation.domain/Rest/
    testingurl:
        test: https://ebs-test.organisation.domain/Rest/
        dev: https://ebs-dev.organisation.domain/Rest/
    checkendpoint: Modules/15866/Screens/u_webservicescreen/Data/datalink

.env

EBSUSERNAME="myebsusername"
EBSPASSWORD="mypassword"
EBSLOCATION="https://ebsOneWebServices-dev.myorganisation.org/Rest/"

使用VPN或防火墙规则来确保数据只能在EBS和您的Web服务器之间移动,以保护数据安全。

如何编辑Web服务

您可以使用客户端的代理设计器执行此操作,允许SMS用户创建SQL查询,这些查询将输入到JSON Web服务中。有大量的开箱即用的SQL查询可供使用,例如搜索(见示例3)。

  1. Access user management

示例

见docs/文件夹

  1. 读取服务
  2. 创建学习者
  3. 创建申请 - 带动态搜索

EBS API文档

您可以在以下位置查看活文档

https://docs.ebs.tribalgroup.com/wsdocs/