嵌入

使用JSON web tokens获取卡片和仪表盘的各种端点。端点与api/public/中的端点相同，只是在授权方式上有所不同。

要使用这些端点

1.  Set the `embedding-secret-key` Setting to a hexadecimal-encoded 32-byte sequence (i.e., a 64-character string).
    You can use `/api/util/random_token` to get a cryptographically-secure value for this.
2.  Sign/base-64 encode a JSON Web Token using the secret key and pass it as the relevant part of the URL path
    to the various endpoints here.

令牌可以有以下字段

  {:resource {:question  <card-id>
              :dashboard <dashboard-id>}
   :params   <params>}.

GET /api/embed/card/:token

使用带有 embedding-secret-key 签名的 JSON Web Token 获取卡片。

令牌应具有以下格式

 {:resource {:question <card-id>}}.

参数

• token

GET /api/embed/card/:token/field/:field-id/remapping/:remapped-id

获取重映射字段值。这与 GET /api/field/:id/remapping/:remapped-id 相同，但用于嵌入式卡片。

参数

• token

• field-id 的值必须是一个大于零的整数。

• remapped-id 的值必须是一个大于零的整数。

• value 的值必须是一个非空字符串。

GET /api/embed/card/:token/field/:field-id/search/:search-field-id

搜索嵌入式卡片引用的字段值。

参数

• token

• field-id 的值必须是一个大于零的整数。

• search-field-id 的值必须是一个大于零的整数。

• value 的值必须是一个非空字符串。

• limit 可空值必须是一个大于零的整数。

GET /api/embed/card/:token/field/:field-id/values

获取嵌入式卡片引用的字段值。

参数

• token

• field-id 的值必须是一个大于零的整数。

GET /api/embed/card/:token/params/:param-key/search/:prefix

嵌入式版本链式过滤搜索端点。

参数

• token

• param-key

• prefix

GET /api/embed/card/:token/params/:param-key/values

嵌入式版本的 api.card 过滤值端点。

参数

• token

• param-key

GET /api/embed/card/:token/query

使用带有 embedding-secret-key 签名的 JSON Web Token 获取运行卡片的成果。

令牌应具有以下格式

 {:resource {:question <card-id>}
  :params   <parameters>}.

参数

• token

• &

• 查询参数

GET /api/embed/card/:token/query/:export-format

类似于 GET /api/embed/card/query，但以指定格式返回文件。

参数

• token

• export-format 枚举值：csv, api, xlsx, json。

• format_rows 可空布尔值。

• 查询参数

GET /api/embed/dashboard/:token

使用带有 embedding-secret-key 签名的 JSON Web Token 获取仪表板。

令牌应具有以下格式

 {:resource {:dashboard <dashboard-id>}}.

参数

• token

GET /api/embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id

使用带有 embedding-secret-key 签名的 JSON Web Token 获取仪表板中卡片的运行结果。

参数

• token

• dashcard-id 的值必须是一个大于零的整数。

• card-id 的值必须是一个大于零的整数。

• &

• 查询参数

GET /api/embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:export-format

使用带有 embedding-secret-key 签名的 JSON Web Token 获取仪表板中卡片的运行结果，并返回数据为指定的导出格式。

参数

• token

• export-format 枚举值：csv, api, xlsx, json。

• dashcard-id 的值必须是一个大于零的整数。

• card-id 的值必须是一个大于零的整数。

• format_rows 可空布尔值。

• 查询参数

GET /api/embed/dashboard/:token/field/:field-id/remapping/:remapped-id

获取重映射字段值。这与 GET /api/field/:id/remapping/:remapped-id 相同，但用于嵌入式仪表板。

参数

• token

• field-id 的值必须是一个大于零的整数。

• remapped-id 的值必须是一个大于零的整数。

• value 的值必须是一个非空字符串。

GET /api/embed/dashboard/:token/field/:field-id/search/:search-field-id

搜索仪表板中卡片引用的字段值。

参数

• token

• field-id 的值必须是一个大于零的整数。

• search-field-id 的值必须是一个大于零的整数。

• value 的值必须是一个非空字符串。

• limit 可空值必须是一个大于零的整数。

GET /api/embed/dashboard/:token/field/:field-id/values

获取作为嵌入式仪表板参数使用的字段值。

参数

• token

• field-id 的值必须是一个大于零的整数。

GET /api/embed/dashboard/:token/params/:param-key/search/:prefix

嵌入式版本链式过滤搜索端点。

参数

• token

• param-key

• prefix

• 查询参数

GET /api/embed/dashboard/:token/params/:param-key/values

嵌入式版本链式过滤值端点。

参数

• token

• param-key

• 查询参数

GET /api/embed/pivot/card/:token/query

使用带有 embedding-secret-key 签名的 JSON Web Token 获取运行卡片的成果。

令牌应具有以下格式

 {:resource {:question <card-id>}
  :params   <parameters>}.

参数

• token

• &

• 查询参数

GET /api/embed/pivot/dashboard/:token/dashcard/:dashcard-id/card/:card-id

使用带有 embedding-secret-key 签名的 JSON Web Token 获取仪表板中卡片的运行结果。

参数

• token

• dashcard-id 的值必须是一个大于零的整数。

• card-id 的值必须是一个大于零的整数。

• &

• 查询参数

« 返回到 API 索引