如何获取 SupaRes 开放平台 API 密钥(分步指南)
SupaRes 开放平台 API 为开发者提供了强大的图像超分辨率处理工具,能够快速提升图像的清晰度。使用该 API,开发者可以将低分辨率图像通过先进的算法转换为高分辨率图像,应用于各类项目,如图片增强、图像修复等。本文将指导你如何获取SupaRes 开放平台API密钥,并进行初步的可用性测试,同时探讨在使用过程中需要考虑的其他关键因素。
1. 获取SupaRes 开放平台 API密钥步骤
获取SupaRes 开放平台 API密钥的过程相对简单,只需几个步骤即可完成:
1.访问官方网站注册/登录:https://app.supares.com/signup
2.创建账户以后到邮箱中需要验证。
3.登录成功以后就会进入到控制台页面。
4.点击左侧导航栏中的 API访问 ,在当前页面就可以看到密钥相关信息。
2. SupaRes 开放平台 API密钥可用性测试
在获取API密钥后,进行可用性测试是确保其正常工作的重要步骤。以下是使用curl进行测试的一个案例
以下接口为SupaRes 开放平台接口中面部增强接口
输入:
curl https://api.supares.com/1.0/fetch
--user your-api-key: \
--header "Content-Type: application/json" \
--data '{
"url": "https://www.website.com/image.jpg",
"face": {
"enhance": true
}
}'
对于图像处理端点/1.0/upload
和/1.0/fetch
的每个请求,API 将立即返回一个唯一的请求id
,状态代码为202 Accepted
。
输出:
{
"success": true,
"code": 202,
"id": "051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f"
}
访问增强以后的图片
SupaRes API 公开/1.0/results/{id}
端点,您可以使用该端点通过简单的轮询机制获取请求的结果。例如:
输入
curl -u your-api-key: https://api.supares.com/1.0/results/051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f
输出结果
包含了图像的相关信息,例如url地址图像的大小等信息。
{
"success": true,
"code": 200,
"id": "051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f",
"status": "ready",
"url": "https://s3.supares.com/temp-supares/JMxbLxAomXi55re4D5zV/051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f/1-input.webp",
"metadata": {
"format": "webp",
"width": 500,
"height": 200,
"bytes": 23718,
"space": "srgb",
"channels": 3
}
}
3. 使用SupaRes 开放平台 API搭建应用的其他关键考虑因素
在使用SupaRes 开放平台 API搭建应用时,除了获取和测试API密钥外,还需考虑以下因素:
验证
对 API 的所有请求都必须使用HTTP Basic Auth或Bearer Auth通过您唯一的 API 密钥进行身份验证。使用 HTTP 基本身份验证时,您必须提供 API 密钥作为用户名值。您不需要提供密码。如果您需要使用 Authorization 标头通过 Bearer Auth 进行身份验证,则必须将 API 密钥设置为凭据。
所有 API 请求都必须使用 HTTPS 协议发出,以便对流量进行加密。通过纯 HTTP 进行的调用以及未经身份验证的请求都会失败。
速率限制
为了保护 SupaRes 平台并确保系统资源的公平分配,所有请求,无论使用哪种 HTTP 方法和端点,都按每个密钥进行速率限制。速率限制分为 15 分钟间隔,您每 15 分钟最多可以发出100,000 (十万)个请求,这对于合理使用来说绰绰有余(大约每秒 110 个请求)。您将在每个响应中找到标准X-RateLimit-*
标头,以帮助您跟踪使用情况。
X-RateLimit-Limit: 100000 | 当期允许的请求数 |
---|---|
X-RateLimit-Remaining: 2120 | 本期剩余请求数 |
X-RateLimit-Reset: 778 | 当前时间段剩余秒数 |
错误处理
SupaRes API 返回传统的 HTTP 响应代码以指示 API 请求的成功或失败。成功的请求将始终产生2xx
代码范围。 4xx
范围内的状态代码通常表示发送的请求存在问题(例如省略了必需的参数)。如果您收到5xx
范围内的状态,这通常表明存在服务器端问题,并且意味着我们这边遇到问题,当前无法满足您的请求。
4. SupaRes 开放平台 API密钥申请和使用中的常见问题
在申请和使用 SupaRes 开放平台 API密钥过程中,你可能会遇到以下常见问题:
提供免费计划吗?
我们提供免费计划,并且注册不需要信用卡。每次注册一开始都是免费计划,一次性配额为 10 个积分。
我可以稍后更改计划吗?
您可以在付费计划之间切换,或者随时完全取消您的帐户。我们将相应地调整任何付款。
积分如何运作?
1 个积分等于处理 1 张图像。我们不会对每次操作收取任何额外费用。这意味着您可以在一张图像上应用我们提供的每一种人工智能图像增强功能,我们将从您的帐户中扣除一笔积分。
需要信用卡才能注册吗? 如果您选择购买按月订阅,则只会要求您提供信用卡或借记卡。您无需输入任何付款信息即可开始免费计划。
5. SupaRes 开放平台 API进阶指引
在获得SupaRes 开放平台 API密钥之后,即可开启API接口对接,本文整理了多篇使用SupaRes 开放平台 API的案例,帮助读者更有效地使用SupaRes 开放平台 API:
音调调整、 噪音消除、 减少伪影、 图像优化、 图片上传、 图像获取
6. 常见问题
问题1: 什么是幂简集成平台?
幂简集成是蜜堂有信在2023年打造的一款SAAS产品,建设着国内最全的API平台,为开发者提供全面、高效、易用的API集成管理方案,一站搜索、试用、集成国内和国外API。让用户在AI时代全方位接入互联网,用API连接一切服务和算力,实现价值倍增。
问题2:如何找到SupaRes 开放平台 API
幂简API平台可以通过以下两种方式找到所需API:通过关键词搜索API(例如,输入’SupaRes 开放平台 API‘这类品类词,更容易找到结果)、或者从API hub分类页进入寻找。
问题3:SupaRes 开放平台 API的替代品有哪些?
市场上存在免费、付费两种替代者
例如
更多竞品可以在SupaRes 开放平台找到。
7. 总结
本文详细介绍了如何获取和测试SupaRes开放平台API密钥,并提供了使用curl进行可用性测试的具体示例。通过测试,开发者能够确认API的正常工作,并了解如何通过轮询机制获取处理后的图像。文章还探讨了在使用SupaRes API时需要注意的关键因素,如身份验证、速率限制和错误处理等,帮助开发者更好地集成该平台的图像处理功能。