API使用政策

Last Updated: 2026年1月12日Effective Date: 2026年1月12日

翻译声明

⚠️ 重要声明:本文件由土耳其语翻译而来。如本翻译版本与土耳其语原文存在任何差异,以土耳其语版本为准。

土耳其语原文请访问:https://evaste.co/tr/legal-center/api-usage-policy

1. 引言和范围

1.1. 目的

本API使用政策('政策')规范Evaste API的使用,包括条件、限制和要求。通过使用API,您可以通过编程方式访问Evaste的数据保护和同意管理服务。

1.2. 定义

"API":应用程序编程接口 - 提供对Evaste服务的编程访问的接口。

"API密钥":用于访问API的唯一身份验证密钥。

"端点":通过API可访问的特定功能或资源。

"速率限制":在指定时间段内允许的最大API调用次数。

"Webhook":当某些事件发生时,Evaste发送到客户系统的HTTP回调。

"SDK":软件开发工具包 - 便于API集成的库。

1.3. 范围:REST API (v2)、GraphQL API、Webhook传递系统、JavaScript SDK、服务器端SDK(Node.js、Python、PHP、Ruby)。

2. API访问和身份验证

2.1. 访问要求:活跃的Evaste账户、包含API访问权限的订阅计划、生成的API密钥、接受本政策。

2.2. API密钥类型

密钥类型范围使用场景
公钥只读前端集成
密钥完全访问后端集成
Webhook密钥验证Webhook签名验证
测试密钥沙箱开发/测试

2.3. 身份验证方法:API密钥身份验证(X-API-Key头)、Bearer Token身份验证、OAuth 2.0(企业版计划)。

2.4. API密钥安全(强制):切勿在客户端代码中使用密钥、不要在源代码中存储API密钥、使用环境变量或安全保险库系统、定期轮换密钥(建议:90天)。

3. 使用限制和配额

3.1. 速率限制

计划请求/分钟请求/小时请求/天
Pro1003,00050,000
企业版1,00030,000500,000
企业版Plus10,000300,0005,000,000

3.2. 端点限制:Read(GET)= 计划限制、Write(POST/PUT)= 限制 × 0.5、Delete = 限制 × 0.2、批量操作 = 限制 × 0.1。

3.3. 突发限制:Pro(200/秒,持续10秒)、企业版(500/秒,持续30秒)、企业版Plus(2,000/秒,持续60秒)。

3.4. 超出限制:HTTP 429响应、Retry-After头指示等待时间、持续超出可能导致账户暂停。

4. API使用规则

4.1. 一般规则:仅将API用于文档化的目的、所有API调用通过HTTPS进行、适当处理错误响应。

4.2. 客户端要求:有效的User-Agent头、Content-Type: application/json、Accept: application/json。

4.3. 数据格式:请求/响应使用JSON格式、日期使用ISO 8601格式(UTC)、编码UTF-8。

4.4. 分页:默认页面大小20、最大100、首选游标分页。

4.5. 幂等性:对关键写入操作使用Idempotency-Key头、推荐UUID v4格式。

5. 数据安全和隐私

5.1. 数据加密:所有API流量使用TLS 1.2+加密、最低密码强度AES-256。

5.2. 个人数据处理:遵守GDPR和KVKK要求、应用数据最小化原则、支持数据主体权利。

5.3. 审计日志:所有API调用都被记录、90天在线访问、1年存档。

6. API版本控制

6.1. 版本政策:语义化版本控制(vMajor.Minor)、当前稳定版本:v2、旧版本v1(已弃用,将于2026年第四季度终止)。

6.2. 指定版本:URL路径(推荐):/api/v2/consents、头:X-API-Version: 2。

6.3. 向后兼容性:次要版本更新向后兼容。

6.4. 弃用政策:弃用功能至少支持12个月、破坏性更改提前6个月通知。

7. 集成要求

7.1. 官方SDK:JavaScript (@evaste/js-sdk)、Python (evaste-python)、PHP (evaste/php-sdk)、Ruby (evaste-ruby)、Java (evaste-java)、.NET (Evaste.SDK)。

7.2. 强烈建议使用SDK:自动重试机制、速率限制处理、错误处理、类型安全。

7.3. Webhook集成:需要HTTPS端点、接受POST请求、5秒内响应、返回2xx响应代码。签名验证为强制性。

7.4. 测试环境:基础URL:https://api.sandbox.evaste.co

8. 错误处理

8.1. HTTP状态码:200(成功)、400(错误请求)、401(未授权)、403(禁止)、404(未找到)、429(请求过多)、500(服务器错误)。

8.2. 重试策略:使用指数退避、首次重试:1秒、最大:5次尝试、添加抖动。

9. 禁止使用

9.1. 严格禁止:利用API安全漏洞、绕过身份验证的尝试、DDoS/DoS攻击、数据抓取、非法活动。

9.2. 受限使用(需书面许可):大量数据传输(每天超过100万请求)、在第三方应用中使用API、白标集成。

10. 责任和保证

10.1. Evaste承诺:确保API按文档运行、及时修复安全漏洞、提前通知计划维护。

10.2. 保证免责声明:API按'原样'提供。Evaste不保证:不间断访问、无错误运行。

10.3. 责任限制:最大责任限于过去12个月支付的费用。

11. API更改和终止

11.1. 更改通知:新功能(立即)、次要更改(30天)、破坏性更改(6个月)、API终止(12个月)。

11.2. 通知渠道:api-updates@evaste.co、开发者博客、仪表板通知。

11.3. 数据导出:终止前30天导出期。

联系信息

Evaste API团队

API支持:api-support@evaste.co

安全:security@evaste.co

文档:https://docs.evaste.co

API参考:https://api.evaste.co/docs

沙箱:https://api.sandbox.evaste.co