创建API-Key

Supametas.ai Service API 使用 API-Key 进行鉴权。

建议开发者把 API-Key 放在后端存储,而非分享或者放在客户端存储,以免 API-Key 泄露,导致财产损失。

创建API-Key

API Configuration

1. API密钥管理

在“API配置”页面,你可以管理API密钥,以便将数据推送到外部系统或应用。API密钥管理包括创建新密钥、删除密钥和启动数据推送。

  1. 创建新密钥

    1. 点击“新建Key”按钮,打开新密钥创建窗口。

    2. 输入密钥名称:在“key的别名”字段中输入一个描述性的名称,用于标识该密钥的用途。

    3. 点击“确认”按钮完成密钥创建。新创建的密钥将显示在列表中。

  2. 删除密钥

    1. 在API密钥列表中,勾选你要删除的密钥。

    2. 点击“删除”按钮,系统将删除选中的密钥,并停止所有与该密钥相关的数据推送操作。

2. 启动数据推送

你必须在需要接入的系统接入API并设置webhook地址完成后才能启动数据推送,否则会推送失败。

  1. 选择API:在API列表中,勾选需要通过API推送的KEY。

  2. 点击“开始实时推送”按钮,系统将立即开始将清洗完的数据推送到外部系统,实时推送。

  3. 历史数据推送

    • 如果数据集中已经有数据,需要推送历史数据,点击“开始历史推送”按钮。历史数据推送只会在点击此按钮后启动。

    • 历史数据推送状态会显示在列表中,显示推送的进度(如“历史数据推送进度1%”)。

    • 历史数据推送只会进行一次,完成后将不再推送相同的数据。

2.3 停止推送

  • 如果你需要停止当前的推送任务,可以在列表中删除API密钥或在接入系统中停止API运行来终止所有相关的推送任务。

最后更新于