1. 首页
  2. API
  3. 弃用 rixCloud API Version 1

弃用 rixCloud API Version 1

TL;DR

rixCloud API 版本 1 已经正式被弃用,并将于 2019年1月1日 起停止服务,订户需要前往 rixCloud 管理门户获取新的 API 端点(订阅 URI 等)或更新自己的应用程序。


这是什么?

rixCloud API 的版本 2(Version 2)已经正式发布,虽然我们仍然在进行相关调整,但已经可以正式提供服务,以支持更多新特性和新功能。

同时,服务于 rixCloud 订户一年有余的 API 版本 1(从 2017年6月15日 开始提供)现已经不能满足 rixCloud 业务要求,被正式弃用。


这会影响什么?

所有使用 rixCloud API 的订户都将受到影响。因为 rixCloud API 的端点已经发生变化,继续使用旧的 API 端点虽然暂时仍然可以获取到数据,但在 2019年1月1日 后,rixCloud API 版本 1 将彻底关闭,届时使用旧 API 端点将不能再获取到任何数据。


我需要怎么做?

Surge

使用 Surge 托管型配置的订户几乎不需要手动进行任何操作,即使订户仍然在使用 API v1 的配置 URI,但从 2018年11月17日 00:00:00 UTC+0800 开始(此时间可能提前),所有下发的 Surge 配置文件更新 URI 都会更新为 rixCloud v2 的地址。这意味着使用 rixCloud 托管型配置的订户只需要手动更新或等待 Surge 自动更新一次配置文件,就不再需要进行任何操作。

SSR 订阅

使用 SSR 订阅的订户需要手动更新一次订阅 URI,这是因为 SSR 订阅的官方实现中并不提供更新应用程序订阅 URI 的功能。这部分订户需要前往 rixCloud 管理门户获取新的 API 订阅 URI 并在应用程序中替换旧的 URI。

这个 API URI 非常重要,你应当把它当做密码一样妥善保管,避免泄露。

应用程序开发者

请在 rixCloud 知识库查看新的 API 文档。

rixCloud API 存在速率限制,请先在 rixCloud API 文档上进行调试确认无误后再进行应用程序开发,多次无效 API 调用可能会导致你的 IP 地址被 rixCloud WAF 或 Cloudflare 封锁。

rixCloud 预计将很快提供用于测试的暂存环境 API 端点。


可能存在的问题

rixCloud API 版本 2 会检查订户的订阅设置是否与所选择的客户端类型兼容。因此,如果订户选择了不能互相兼容的配置的,API 就会返回错误「Configuration is not compatible」。

Surge / Clash 等原版协议的客户端不能兼容 SSR 协议,即协议插件的值为「无兼容」的全部协议插件。

SSR 客户端不能兼容 AEAD 加密方式。

如果需要同时使用原版协议客户端和 SSR 客户端,请确保订阅设置中所有设置项目的值均为「兼容」。

此外,一部分加密方式已经被 rixCloud 弃用,使用这些加密方式的订户无论选择哪种客户端协议,API 都不会输出内容而是返回错误「Configuration is not compatible」。这部分订户请更新你的加密方式设置。关于此问题的详情,请参考此公告

更新 十一月 16, 2018

相关文章

发表评论