用于统计、评论、评分和电话的REST JSON API

Astrina 背后的数据——网站分析、评论、评分摘要和电话智能——现在可以直接拉入您的代码中。开发者 API 是一个 REST JSON API，可以通过一个密钥返回所有数据。

一个密钥，四个端点

API 的版本为 /api/v1，每个端点都使用普通的 JSON。将您的客户端指向您需要的资源：

• GET /api/v1/stats——您拥有的网站的分析：访客、页面浏览量、热门页面、来源和国家。
• GET /api/v1/reviews——主题的评论和评分。
• GET /api/v1/rating——带有星级分布的评分摘要。
• GET /api/v1/phone——电话智能。

在这些基础上，Auth API 支持 "使用 Astrina 登录"，这样您就可以将社交登录添加到自己的应用程序中，而无需自己构建身份堆栈。

以适合您堆栈的方式进行身份验证

从 /my/api.php 获取一个密钥，然后以对您的客户端最干净的方式发送。API 接受三种形式：

• 一个X-Api-Key 头部。
• 一个Authorization: Bearer 令牌。
• 一个?api_key=查询参数。

基于头部的认证是服务器端代码的最安全默认选项；查询参数适合快速测试和浏览器端调用。响应是CORS开放的，因此您可以在适合的时候直接从前端调用API，并且它们被标记为noindex以便您的数据不会泄露到搜索引擎中。

配额和计划

使用量按天计量，每个响应都会告诉您当前的状态——每个有效载荷都包含您的配额使用情况，因此您无需猜测剩余的调用次数。

• 免费层：每天100次调用。
• API计划：每30天€19可获得10,000次调用。
• 商业分析层：API 访问已包含。

从免费版开始进行原型设计，然后在集成需要更多空间时升级。

可预测的 JSON，可预测的错误

成功和失败都以 JSON 形式返回。当出现问题时，响应中会携带一个error字段和正确的 HTTP 状态码，因此您的错误处理可以根据状态码分支，而不是解析字符串：

• 401 — 错误的密钥。
• 429 — 超出配额。
• 400 / 422 — 错误的参数。

由于配额状态在每个响应中都包含，表现良好的客户端可以在看到 429 之前就退回。

如何开始

1. 打开 /my/api.php并创建一个 API 密钥。
2. 选择一个端点 — 从 /api/v1/stats 开始，针对您拥有的网站。
3. 在 X-Api-Key 头中发送您的密钥，并读取 JSON 响应。

第一次调用是一个单行命令：

curl -H "X-Api-Key: YOUR_KEY" https://astrina.io/api/v1/stats

更喜欢使用承载令牌？更换头部：

curl -H "Authorization: Bearer YOUR_KEY" https://astrina.io/api/v1/reviews

或者直接将密钥放入 URL 进行快速检查：

curl "https://astrina.io/api/v1/rating?api_key=YOUR_KEY"

从那里，相同的模式涵盖了评级和电话智能——一个密钥，一个标题，四个数据源。获取您的密钥，今天就拨打您的第一个电话。