跳转到内容

入门

更新日期 2025-04-29

https://REGION.onetimesecret.com/api

其中,"REGION "可以是 "US "或 "EU"。

数据位置和区域选择*

  • 选择一个地区(例如美国 us.onetimesecret.com) 或欧盟 (eu.onetimesecret.com) 。所有选项请参见 区域
  • 考虑数据主权、延迟和合规要求等因素
  • ** 注意:** 默认情况下,onetimesecret.com 仍可运行并路由至活动数据中心,建议使用特定区域,因为该功能将来可能会被淘汰。 ::

我们支持两种 API 使用模式:

https://USERNAME:APITOKEN@REGION.onetimesecret.com/api

  • 使用 HTTP 基本身份验证以获得完整的 API 功能
  • 用户名是您的账户登录名
  • 密码是您账户页面上的 API 令牌

https://REGION.onetimesecret.com/api

  • 无需验证即可使用有限的功能
  • 一次性快速共享秘密的理想选择
  • 可用于创建和检索秘密

Onetime Secret 支持多个地理数据中心。我们遵循地区间零数据共享政策,确保数据完全隔离。根据您的需求选择合适的数据中心:

  • 您可以通过直接导航到所需的域来选择特定的数据位置
  • 从生成的链接(例如,us.onetimesecret.com/secret/abcd1234)中,您的秘密位置始终一目了然。
  • 注意: 目前,通过 onetimesecret.com/api 访问仍然有效,但建议使用特定的数据域,因为该功能将来可能会被淘汰。

##自定义域名 Onetime Secret通过我们的Identity Plus计划,为有特定网络或品牌要求的组织支持自定义域配置。

  • 私人品牌:** 使用您自己的域(例如,secrets.example.com)进行应用程序接口访问和秘密共享
  • 一致的用户体验:** 与客户和合作伙伴保持组织的视觉形象和信任身份。
  • 在员工培训中使用:** 使用自定义域来强化组织的安全实践和工作流程。

高级功能 我们的Identity Plus计划提供自定义域名。使用我们易于使用的配置选项,只需几分钟即可完成设置。了解更多。 ::

使用自定义域时,所有 API 端点都遵循相同的结构:

https://secrets.example.com/api

GET https://REGION.onetimesecret.com/api/v1/status 系统当前状态。

参数:

Terminal window
$ curl -u 'USERNAME:APITOKEN' https://eu.onetimesecret.com/api/v1/status
{"status": "nominal"}
Terminal window
$ curl -u 'USERNAME:APITOKEN' https://us.onetimesecret.com/api/v1/status
{"status": "nominal"}