API
概览
GraphQL 是一种用于 API 的查询语言。它让您可以在一次调用中精确请求所需的数据,而无需处理许多固定的 REST 端点。
该 API 基于 GraphQL 构建。每种资源,例如车辆、充电站、路线和导航会话,都可以通过同一个 GraphQL API 访问。您可以将它们作为查询(query)、变更(mutation)或订阅(subscription)来访问。
如果您刚接触 GraphQL,可以从 GraphQL 官方文档开始。
GraphQL 端点
查询、变更和订阅可通过以下端点访问。示例请参见发送您的第一个请求。
对于查询和变更,请使用:
对于订阅,请使用:
资源
按资源浏览 API。下面的每个部分都链接到其查询、变更和订阅。
| 资源 | 描述 |
|---|---|
| 车辆 | 查询 EV 规格、能耗模型和高级价格数据。 |
| 联网车辆 | 将车辆连接到连接服务提供商并获取其实时数据。 |
| 充电站 | 查询单个充电站、附近的充电站和设施。 |
| 充电站评价 | 读取、添加和删除充电站的用户评价。 |
| 充电站费率 | 查询在充电站充电的费用。 |
| 充电站运营商 | 查询充电站的充电桩运营商的详细信息。 |
| 地图瓦片 | 以矢量或 JSON 地图瓦片的形式获取充电站数据,用于在地图上渲染。 |
| 路线 | 计算包含充电停靠点、能耗和行驶时间的 EV 路线。 |
| 货车路线 | 计算考虑车辆重量和尺寸的电动货车路线。 |
| 导航 | 跟踪车辆沿路线的行驶进度并接收实时更新。 |
| 排放 | 计算选择某条路线所减少的排放量。 |
| 等值线 | 根据车辆的电量状态,可视化车辆从某一点出发可到达的区域。 |
身份验证
每个请求都通过 x-client-id 和 x-app-id 请求头进行身份验证。有关如何获取和发送它们,请参见授权。
分页
列表查询使用 size 和 page 参数,或者对于基于游标的分页,使用 first 和 after 参数。详情请参见分页。
速率限制
请求受速率限制约束。
生命周期
Chargetrip 使用单一的、持续演进的 GraphQL API,而不是带版本的发布。有关我们如何处理破坏性和非破坏性变更,请参见生命周期。
此内容是否有帮助?