开发者访问

Get Tools Lab 开发者 API

使用经过身份验证的开发人员端点集成已发布的工具、指南和平台工作流程。可用功能取决于启用的 API 模块和您的访问级别。

API 选项

该平台包括 REST 端点和轻量级 GraphQL 兼容层,支持 API 密钥、OAuth 客户端凭据、使用情况分析、速率限制和签名 Webhook 交付。并非所有公共网站功能都可以通过 API 自动使用。

身份验证

REST v1 端点可以使用 API 密钥 X-API-Key 标题。较新的端点也可以接受支持的承载令牌。对所有凭据保密,如果密钥泄露,请立即轮换密钥。

curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"

常见 REST 端点

工具s

GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json

指南s

GET /api/v1/guides.php
GET /api/v1/guides.php?q=image

REST v2 和 GraphQL

整合的开发者平台可以为支持的资源公开更新的 REST 路由和 GraphQL 操作。使用开发人员区域和 API 游乐场来查看当前部署中实际启用的端点。

速率限制

API 请求可能会受到每分钟或每天的限制。超出限制的请求可以返回 HTTP 429 Too Many Requests 以及重试或重置信息。应用程序应该使用退避而不是立即重复失败的请求。

Webhooks

支持的事件可以传递到 HTTPS webhook 目标。在启用签名的情况下,请在信任负载之前验证 HMAC 签名。 Webhook 使用者还应该容忍重试,并且应该使事件处理具有幂等性,以便相同的传递不会创建重复的操作。

错误s

无效的凭据、禁用的客户端、耗尽的配额或格式错误的请求可能会返回带有 HTTP 4xx 状态代码的结构化 JSON 错误。服务器端故障使用 5xx 响应。应用程序应记录可用的响应状态和请求标识符,而不是在错误报告中公开秘密凭据。

安全 guidance

  • 切勿在公共浏览器 JavaScript 中嵌入秘密 API 密钥。
  • 对 API 和 Webhook 流量使用 HTTPS。
  • 仅向客户端授予他们所需的权限。
  • 验证 webhook 签名。
  • 轮换受损的凭据。
  • 遵守记录的速率限制和文件大小限制。

SDK 和 Playground

请访问开发者部分以获取 SDK 示例和交互式游乐场。在使用生产文件或客户信息之前测试与非敏感数据的集成。