配置API概述

在这一页上


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

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

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

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

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

目前还没有特定于语言的客户机。然而,API参考还包含卷曲,go,node,python等示例代码片段。

快速开始

您可以从命令行与API交互。首先安装卷曲工具。

美元酿造安装卷曲

访问令牌

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

这些目前只适用于第一方可信的应用程序,如您的个人本地脚本和服务器端程序。合作伙伴不应提示用户输入用户名和密码,也不应保存访问令牌作为委托访问的方式。看到身份验证doc获取更多信息。

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

秘密令牌

您无法检索纯文本令牌稍后,您应该将它保存在一个秘密管理器中。如果你失去了令牌您可以生成一个新的。

API请求

现在您有一个访问令牌,您可以使用此令牌来通过设置它来访问配置API的其余部分授权例如,您的请求标题:

ACCESS_TOKEN美元=qitgisif4zprgbbbb_5j4hxfp3qdbxrntwwwoahgamr8.gg9ok4bk7swlp67rfyxeh3abbsxywqnuoxbxzpv1y2g美元卷曲\-X得到\-H“授权:承担者$ Access_Token.\https://platform.segmentapis.com/v1beta/workspaces

示例响应:

{“工作区”:({“名称”:“工作区/ myworkspace”,“display_name”:“我的空间”,“ID”:“e5bdb0902b”,“create_time”:“2018 - 08年- 08 - t13:24:02.651z”}),“next_page_token”:”“}

参考

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

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

最后更改:2021年3月10日



开始使用细分

段是将网站和移动应用程序数据集成到超过300个分析和增长工具的最简单方法。
或者
创建免费帐户