配置API概述

在这一页上


Config API使您能够以编程方式管理段工作区、源、目标等。使用API,您可以:

  • 列出所有工作区的源和目的地,以查看数据如何通过段流动
  • 用几行代码创建或删除新的目的地
  • 创建新用户并将其分配给限定范围的角色
  • 配置、禁用或查看源并管理连接的目标
  • 获得片段目录中所有可用的源和目的地的完整视图
  • 配置跟踪计划以查看数据如何符合您预期的模式
  • 查询事件交付指标以构建自定义仪表板和警报,以监视事件向目的地的交付
  • 过滤到达特定目的地的整个事件或单个字段

配置API是segmentapis.com下的一组REST服务:

服务 描述
访问令牌 管理访问令牌
源目录 获取关于所有事件和云资源的信息
目标目录 获取关于所有目的地的信息
工作区 获取有关工作区的信息
来源 管理工作区源
目的地 管理工作区目的地
跟踪计划 管理工作区跟踪计划
事件交付标准 获取云模式目标的事件交付指标
目的地过滤器 管理目标筛选器
管理工作区用户和角色
功能 管理功能

要查看所有的API方法和模型,请查看段配置API参考

目前没有特定于语言的客户端。然而API参考还包含cURL、Go、Node、Python等的示例代码片段。

快速启动

您可以从命令行与API交互。第一次安装旋度工具。

酿造安装旋度

访问令牌

您可以使用带有访问令牌的Config API以编程方式访问令牌可以访问的Segment资源。访问令牌是由工作区所有者使用Access Management页面创建的,并且只能访问令牌拥有权限的资源。

这些目前只适用于第一方、受信任的应用程序,如您的个人本地脚本和服务器端程序。合作伙伴不应提示Segment用户输入用户名和密码,并保存访问令牌作为委托访问的方式。看到认证了解更多信息。

当您创建一个访问令牌时,您将给它一个描述、一个工作区,并确定它是否具有工作区所有者或成员访问权。

秘密令牌

您不能检索纯文本代币稍后,所以你应该把它保存在一个秘密的经理。如果你输了代币您可以生成一个新的。

API请求

现在您有了一个访问令牌,您可以使用这个令牌来访问Config API的其余部分,方法是在授权请求的头部,例如:

ACCESS_TOKEN美元qiTgISif4zprgBb_5j4hXfp3qhDbxrntWwwOaHgAMr8.gg9ok4Bk7sWlP67rFyXeH3ABBsXyWqNuoXbXZPv1y2g旋度- x收到- h“授权:持票人ACCESS_TOKEN美元https://platform.segmentapis.com/v1beta/workspaces

示例响应:

“工作区”“名称”“工作区/myworkspace”“显示名称”“我的空间”“id”“e5bdb0902b”“create_time”“2018-08-08T13:24:02.651Z”],“下一页\u令牌”""

参考

有关API的通用设计模式的概述以及关于版本控制和兼容性的重要信息,请参见API设计文档。

要查看所有的API方法和模型,请查看段配置API参考

本页最后修改日期:2021年3月10日



从Segment开始

细分是将你的网站和手机应用数据整合到300多个分析和增长工具中的最简单方法。
创建免费帐户