Webhook
要配置网络挂接定义配置文件, 您必须拥有如下角色:
- 通用系统管理员
webhook为用户定义的HTTP回叫，通常由一些事件触发且包含事件结果和状态的信息。
Alma可以在以下情况发生时发送webhook。
有关触发webhook的完整事件列表，见开发者网络中的支持的事件。
要启用webhook，Alma必须配置webhook集成配置文件（见下文）。
对于使用通知的webhook，作为集成配置文件创建的一部分，您将会在信件活动代码表中启用所需的webhook。 但是，一旦集成配置文件创建后，要启用其他webhook或禁用webhook，您无需再次打开信件活动代码表 - 您可以在信件配置表中完成：
有关这些webhook的详情，见https://developers.exlibrisgroup.com/alma/apis/xsd/rest_webhook_notifications.xsd。
有关这些webhook的详情，见https://developers.exlibrisgroup.com/alma/apis/xsd/rest_webhook_notifications.xsd。
配置webhook集成配置文件
要配置webhook类型的集成配置文件：
- 在集成配置文件列表页面（配置菜单 > 通用 > 外部系统 > 集成配置文件），点击添加集成配置文件。 打开集成配置文件向导的第一页。
- 从集成类型下拉列表，选择Webhooks并为配置文件输入唯一的代码和名称。
- 选择下一步。 打开向导的第二页。
Webhook配置 - 点击激活激活webhook集成配置文件。 配置文件激活前状态为待激活。
- 输入webhook收听者URL的收听者URL以及秘钥字段的秘钥代码。 关于此处输入的值的信息，见Webhooks中的技术信息表格。
- 选择消息类型为XML或JSON。
- 在订阅下：
- 选择作业完成在作业完成运行时发送webhook（使用Alma界面或API）。
- 选择通知在发送上文列出的通知时发送webhook。
选择配置通知类型打开信件活动代码表，转至底端对这些通知启用webhook。 此前启用的webhook（在这里或在信件配置表中）显示为启用；您在此启用的webhook会在信件配置表中显示为启用。 启用所需的通知后选择保存返回集成配置文件。
- 选择用户在用户信息更新时发送webhook。 这包括所有用户更改。 请注意，使用API执行的用户更改不会触发发送webhook。 在用户组框，选择触发发送webhook的用户组。 如果未指定用户组，会为所有用户组发送webhook。
- 选择请求以在创建预约、预订、移动、数字化或内部工作单请求时或放置在预约书架上时发送webhook。
- 选择外借以在创建外借、归还或声明丢失时发送webhook。
- 选择书目记录以在更改书目记录时发送webhook。
- 选择纸本单册以在纸本单册更改时发送webhook。
- 选择 保存. 配置的配置文件显示在集成配置文件列表。
- 在集成配置文件定义后，您可以从集成配置文件操作列表选择查看日志。 该选项使您可以查看webhook事件的日志。 可以检索URL和荷载元素。
- 如果webhook尝试失败，会向在webhook配置文件的联系信息选项卡中设置的电子邮件地址发送电子邮件。
- 在高级沙盒环境中，Webhook Listener URL移除且配置文件设置为禁用。 这是因为沙盒环境中的webhook操作也会对生产数据相关的服务器造成影响，这会将测试数据和生产数据混淆。 如果想要启用沙盒环境中的集成配置文件，按照上文的步骤4、5进行。