Faspex 5 应用程序接口与以前版本的区别

Faspex 4（及之前）与 Faspex 5 的集成迁移矩阵

项 Faspex 4 及以上版本 Faspex 5
认证
  • 基本认证
  • SAML
  • Faspex 5 用户界面登录页面
  • SAML
授权
  • OAuth 流
  • 经 HMAC 签名的承载令牌
  • OAuth 2 流程
  • JWT 授予流程（可选择冒充）
个 API RESTful 具有 OAS 3.0 文件的 RESTful（允许任何行业标准代码生成器构建客户端库）
API 基本路径 /aspera/faspex/api/ /aspera/faspex/api/v5/
数据传输 使用应用程序接口创建 Faspex 软件包。 使用 Aspera 传输工具或 SDK 挑选文件并执行传输。 兼容的传输工具和 SDK 有
  • ascp
  • 连接 SDK
  • HTTP 网关 Javascript SDK
  • FaspManagerSDK
 使用应用程序接口创建 Faspex 软件包。 使用 Aspera 传输工具或 SDK 挑选文件并执行传输。 兼容的传输工具和 SDK 有
  • ascp
  • 连接 SDK
  • HTTP 网关 Javascript SDK
  • TransferSDK
发送软件包工作流程 v3
  1. 调用 POST /send。
  2. 将 JSON 响应字段直接映射到传输工具或 SDK 字段，开始上传传输。
    注意：此过程容易出错。
v4
  1. 调用 POST /api/users/me/packages。
  2. 在请求中使用 {"direction": "send"} 调用 POST /api/users/me/packages/{package_id}/transfer_specs 。
  3. 将 JSON 响应字段直接映射到传输工具或 SDK 字段，开始上传传输。
    注意：此过程容易出错。
  1. 调用 POST /packages 创建一个软件包。
  2. 通过调用 POST /packages/{id}/transfer_spec/upload 检索有效的传输规范
  3. 开始上传传输，将获取的
    1. 或直接将 transfer_spec JSON 响应传递给 Connect API AW.Connect#startTransfer : (安全)
    2. 或直接将 transfer_spec JSON 响应传递给传输 SDK StartTransfer : (安全)
接收包裹 在发送或接收软件包时调用 API，然后进行 FASP 传输 在所有其他用例中使用 casesAPI-only 调用 在发送或接收软件包时调用 API，然后进行 FASP 传输 在所有其他用例中使用 casesAPI-only 调用
SDK Java SDK 支持数量有限的 API 端点 我们努力使代码生成变得简单，涵盖整个应用程序接口端点。 提供的示例

认证和授权

Faspex 5 采用 OAuth 2 作为其应用程序接口的授权机制。 Faspex V3 API 使用安全性较低的 HTTP 基本授权，而 Faspex V4 API 没有将用户身份验证与授权解耦。

管理员可以注册一个应用程序接口客户端，获取一个承载令牌，以便与端点进行交互。 承载令牌可通过 JWT 授权流、授权码流或带 PKCE（代码交换证明密钥）的授权码流获得。

应用程序接口差异

软件包应用程序接口

在 Faspex 5 应用程序接口中，软件包由顶级端点处理，不需要通过所有权（如用户或工作组）来识别软件包。 Faspex 5 希望您使用软件包 ID 直接与软件包交互。 套餐可用性取决于当前登录用户的角色。 这一更改使软件包的使用更加方便，但可能要求从 Faspex 4 迁移到 Faspex 4 的用户使用多个端点来实现相同的目标。

计划在未来的 Faspex 5 版本中增强搜索和范围界定功能。

端点
API 调用
查看所有套餐（管理员搜索）

Faspex 4

POST /api/packages/

Faspex 5

GET /api/v5/all/packages

引用型

获取用户的所有软件包

Faspex 4

GET /api/users/{user_id}/packages/

Faspex 5

  • 查看当前用户可使用的所有软件包：
    GET /api/v5/packages

    引用型

  • 作为管理员，可查看其他用户可用的所有软件包：

    GET /api/v5/packages?q=username
    q 查询参数可搜索发件人和收件人用户字段。

    引用型

查看所有套餐（管理员搜索）

Faspex 4

POST /api/packages/

Faspex 5

GET /api/v5/all/packages
引用型
获取用户的所有软件包

Faspex 4

GET /api/users/{user_id}/packages/

Faspex 5

查看当前用户可用的所有软件包：
GET /api/v5/packages

引用型

作为管理员，可查看其他用户可用的所有软件包：
GET /api/v5/all/packages
根据收件人用户 ID 对响应进行排序。

引用型

获取用户的软件包

Faspex 4

GET /api/users/{user_id}/packages/{package_delivery_id}

Faspex 5

使用软件包 ID 搜索软件包：

GET /api/v5/packages/{package_id}

引用型

创建数据包

Faspex 4

POST /api/users/{user_id}/packages

Faspex 5

POST /api/v5/packages

引用型

删除用户的软件包

Faspex 4

DELETE /api/users/{user_id}/packages/{package_delivery_id}

Faspex 5

DELETE /api/v5/packages/{package_id}

引用型

从 Dropbox 中删除软件包

Faspex 4

DELETE /api/dropboxes/{dropbox_id}/packages/{package_delivery_id}

Faspex 5

DELETE /api/v5/packages/{package_id}

引用型

删除用户的所有软件包

Faspex 4

DELETE /api/users/{user_id}/packages

Faspex 5

  1. 获取套餐列表：
    • 查看当前用户可使用的所有软件包：
      GET /api/v5/packages

      引用型

    • 作为管理员，可查看其他用户可用的所有软件包：

      GET /api/v5/packages?q=username
      q 查询参数可搜索发件人和收件人用户字段。

  2. 使用软件包 ID 删除多个软件包：

    DELETE /api/v5/packages?ids={package_id, package_id, package_id...}

    引用型

删除 Dropbox 中的所有软件包

Faspex 4

DELETE /api/dropboxes/{dropbox_id}/packages

Faspex 5

  1. 获取共享收件箱的套餐：
    GET /api/v5/shared_inbox/{shared_inbox_id}/packages

    引用型

  2. 使用软件包 ID 删除多个软件包：

    DELETE /api/v5/packages?ids={package_id, package_id, package_id...}

    引用型

更新和编辑用户的软件包属性、收件人和元数据

Faspex 4

PUT /api/users/{user_id}/packages/{package_delivery_id}

Faspex 5

PUT /api/v5/package/{package_id}

引用型

从 Dropbox 更新和编辑软件包属性、收件人和元数据

Faspex 4

PUT /api/dropboxes/{dropbox_id}/packages/{package_delivery_id}

Faspex 5

PUT /api/v5/package/{package_id}

引用型

搜索用户的软件包

Faspex 4

GET /api/users/{user_id}/packages

Faspex 5

使用不同的筛选器搜索当前用户可用的软件包：
GET /api/v5/{mailbox_type}/packages

引用型

在收件箱中搜索软件包

Faspex 4

GET /api/dropboxes/{dropbox_id}/packages

Faspex 5

使用不同的过滤器在共享收件箱中搜索软件包：

GET /api/v5/shared_inbox/{shared_inbox_id}/packages

引用型

根据收件人类型对回复进行排序。

转发用户的软件包

Faspex 4

POST /api/users/{user_id}/packages/{package_delivery_id}

Faspex 5

POST /api/v5/packages/{id}/forward

引用型

转发收件箱中的包裹

Faspex 4

POST /api/dropboxes/{dropbox_id}/packages/{package_delivery_id}

Faspex 5

POST /api/v5/packagess/{id}/forward

引用型

复制用户的软件包内容

Faspex 4

POST /api/users/{user_id}/packages/{package_delivery_id}/replicate_contents

Faspex 5

Faspex 5 目前不提供。

在 Dropbox 中复制软件包内容

Faspex 4

POST /api/dropboxes/{dropbox_id}/packages/{package_delivery_id}/replicate_contents

Faspex 5

Faspex 5 目前不提供。

删除软件包中的文件和文件夹

Faspex 4

POST /api/users/{user_id}/packages/{package_id}/delete_contents

Faspex 5

Faspex 5 目前不提供。

重命名软件包内容

Faspex 4

POST /api/users/{user_id}/packages/{package_id}/rename_contents

Faspex 5

Faspex 5 目前不提供。

获取包传送所需的传送规范

Faspex 4

POST api/users/{user_id}/packages/{package_id}/transfer_specs

Faspex 5

上传：

POST /api/v5/packages/{package_id}/transfer_spec/upload

引用型

下载：
POST /api/v5/packages/{package_id}/transfer_spec/download

引用型

获取用户的软件包传输历史记录（传输会话

Faspex 4

GET /api/users/{user_id}/packages/{package_delivery_id}/transfers

Faspex 5

上传：

POST /api/v5/packages/{package_id}/upload_details

引用型

下载：

POST /api/v5/packages/{package_id}/download_details

引用型

获取 Dropbox 的软件包传输历史记录（传输会话

Faspex 4

GET /api/dropboxes)/{dropbox_id}/packages/{package_delivery_id}/transfers

Faspex 5

上传：

POST /api/v5/packages/{package_id}/upload_details

引用型

下载：
POST /api/v5/packages/{package_id}/download_details

引用型

启动用户软件包的远程内容上传
Faspex 4
POST /api/users/{user_id}/packages/{package_delivery_id}/transfers

Faspex 5

POST /api/v5/packages/{package_id}/remote_transfer

引用型

节点 API

在 Faspex 5 中，共享现在称为共享文件夹或存储位置。
端点
API 调用
获取所有节点

Faspex 4

GET /api/nodes

Faspex 5

GET /api/v5/nodes

引用型

获取指定节点的份额

Faspex 4

GET /api/nodes/{node_id}/shares

Faspex 5

GET /api/v5/nodes/{node_id}/shared_folders

引用型

元数据概要文件

获取当前元数据配置文件

Faspex 4

GET /api/metadata_profiles

Faspex 5

GET /api/v5/configuration/metadata_profiles

引用型

获取元数据配置文件

Faspex 4

GET /api/metadata_profiles/{id}

Faspex 5

GET /api/v5/configuration/metadata_profiles/{id}

引用型

获取默认元数据配置文件

Faspex 4

GET /api/metadata_profiles/default_profile

Faspex 5

GET /api/v5/configuration/metadata_profiles/default_profile

引用型

验证元数据

Faspex 4

POST /api/metadata_profiles/{id}/validate_metadata

Faspex 5

Faspex 5 目前不提供。

用户 API

端点
API 调用
获取当前用户信息

Faspex 4

GET /me

Faspex 5

GET /api/v5/account

引用型

登录（API v.3)

Faspex 4

POST /aspera/faspex/signon/

Faspex 5

Faspex 5 目前不提供。
查找可用的登录方法（API v.3)

Faspex 4

GET /login/new

Faspex 5

GET /api/v5/saml_configs

引用型

获取用户联系人（API v.3)

Faspex 4

GET /aspera/faspex/address-book

Faspex 5

GET /api/v5/contacts

引用型

获取用户

Faspex 4

GET /api/users

Faspex 5

GET /api/v5/accounts

引用型

创建用户

Faspex 4

POST /aspera/faspex/api/users

Faspex 5

POST /api/v5/accounts

引用型

更新用户

Faspex 4

PUT /aspera/faspex/api/users/{id}

Faspex 5

PUT /api/v5/accounts/{id}

引用型

删除用户

Faspex 4

DELETE /aspera/faspex/api/users/{id}

Faspex 5

DELETE /api/v5/accounts/{id}

引用型

获取用户配置

Faspex 4

GET /api/users/{id}/configuration or GET /api/users/me/configuration

Faspex 5

GET /api/v5/accounts/{id}

引用型

共享收件箱（前身为 Dropboxes）API

列出账户可访问的所有 dropbox（API v.3)

Faspex 4

GET /aspera/faspex/dropboxes

Faspex 5

GET /api/v5/shared_inboxes

引用型

获取 Dropbox 的信息（API v.3)

Faspex 4

GET /aspera/faspex/dropboxes/{dropbox_id}

Faspex 5

GET /api/v5/shared_inboxes/{id}

引用型

Dropbox和工作组成员 API

端点
API 调用
获取当前的 dropbox 会员资格

Faspex 4

GET /api/dropbox_memberships

Faspex 5

  • 成员：

    GET /api/v5/shared_inboxes/{shared_inbox_id}/members

    引用型

  • SAML 组：

    GET /api/v5/shared_inboxes/{shared_inbox_id}/saml_groups

    引用型

获取当前工作组成员

Faspex 4

GET /api/workgroup_memberships

Faspex 5

  • 成员：

    GET /api/v5/workgroups/{shared_inbox_id}/members

    引用型

  • SAML 组：

    GET /api/v5/workgroups/{shared_inbox_id}/saml_groups

    引用型

获取特定的 Dropbox 会员资格

Faspex 4

GET /api/dropbox_memberships/{id}

Faspex 5

Faspex 5 目前不支持。 使用 API 调用显示所有成员，并在响应中查找特定成员。

  • 成员：

    GET /api/v5/shared_inboxes/{shared_inbox_id}/members

    引用型

  • SAML 组：

    GET /api/v5/shared_inboxes/{shared_inbox_id}/saml_groups

    引用型

获取具体的工作组成员

Faspex 4

GET /api/workgroup_memberships/{id}

Faspex 5

Faspex 5 目前不支持。 使用 API 调用显示所有成员，并在响应中查找特定成员：

  • 成员：

    GET /api/v5/workgroups/{shared_inbox_id}/members

    引用型

  • SAML 组：

    GET /api/v5/workgroups/{shared_inbox_id}/saml_groups

    引用型

创建 Dropbox

Faspex 4

POST /api/dropbox_memberships

Faspex 5

POST /api/v5/shared_inboxes

引用型

创建工作组

Faspex 4

POST /api/workgroup_memberships

Faspex 5

POST /api/v5/workgroups

引用型

删除 Dropbox 会员资格

Faspex 4

DELETE /api/dropbox_memberships/{id}

Faspex 5

成员：

DELETE /api/v5/shared_inboxes/{shared_inbox_id}/members/{member_id}

引用型

SAML 组：
DELETE /api/v5/shared_inboxes/{shared_inbox_id}/saml_groups/{saml_group_id}

引用型

删除工作组成员资格

Faspex 4

DELETE /api/workgroup_memberships/{id}
Faspex 5

成员：

DELETE /api/v5/workgroups/{shared_inbox_id}/members/{member_id}

引用型

SAML 组：
DELETE /api/v5/workgroups/{shared_inbox_id}/saml_groups/{saml_group_id}

引用型

SAML 配置应用程序接口

端点
API 调用
获取用户配置文件

Faspex 4

GET /api/user_profile_fields/{saml_configuration_id}
Faspex 5
GET /api/v5/saml_configs/{saml_config_id}/user_profile_fields

引用型

获取当前 SAML 配置

Faspex 4

GET /api/saml_configurations

Faspex 5

GET /api/v5/saml_configs
查找将 default 设为 true 的配置。

引用型

获取 SAML 配置

Faspex 4

GET /api/saml_configurations/{id}

Faspex 5

GET /api/v5/saml_configs/{id}

引用型

Faspex 服务应用程序接口

端点
API 调用
XRDS 发现服务

Faspex 4

GET /

授权：基本

接受： 应用程序/xrds+xml

Faspex 5

Faspex 服务现在在 faspex_services 容器中运行，不能通过 API 发现。 您可以使用
GET /aspera/faspex/health
引用型