API 文档
Geotrackable API 接口
Geotrackable API 可在同一生产域名上供 Android 应用和其他获授权客户端使用。
Android 应用设置
在 Android 的“同步”选项卡中,只将站点源地址保存为端点。不要添加 /api。
https://Geotrackable.com
将本地账户凭据 POST 到 /api/auth/login?useCookies=false&useSessionCookies=false 以登录,然后在 Authorization 标头中发送返回的 bearer 令牌。
预期响应
在客户端发送 bearer 令牌之前,受保护路由会返回 HTTP 401。在浏览器中打开仅限 POST 的路由会返回 HTTP 405,因为浏览器发送的是 GET。
每个离线同步周期都必须先推送,再拉取。
核心 Android 路由
检查 Android 连接时,请先使用这些路由。
| 方法 | 路由 |
|---|---|
GET |
/api/system/status |
POST |
/api/auth/login?useCookies=false&useSessionCookies=false |
POST |
/api/sync/push |
POST |
/api/sync/pull |
GET |
/api/categories/mine |
GET |
/api/notes/mine |
完整路由清单
已发布的 Geotrackable API 路由
此表从正在运行的 Geotrackable 端点表生成,使发布的文档与主机保持一致。
| 方法 | 路由 | 访问 |
|---|---|---|
DELETE |
/api/account |
需要授权 |
GET |
/api/auth/confirmEmail |
匿名 |
POST |
/api/auth/forgotPassword |
匿名 |
POST |
/api/auth/login |
匿名 |
POST |
/api/auth/manage/2fa |
需要授权 |
GET |
/api/auth/manage/info |
需要授权 |
POST |
/api/auth/manage/info |
需要授权 |
POST |
/api/auth/refresh |
匿名 |
POST |
/api/auth/register |
匿名 |
POST |
/api/auth/resendConfirmationEmail |
匿名 |
POST |
/api/auth/resetPassword |
匿名 |
GET |
/api/categories/mine |
需要授权 |
POST |
/api/categories/mine |
需要授权 |
GET |
/api/categories/mine/tree |
需要授权 |
GET |
/api/categories/mine/tree/children |
需要授权 |
GET |
/api/categories/mine/tree/sections |
需要授权 |
DELETE |
/api/categories/mine/{categoryId} |
需要授权 |
POST |
/api/categories/mine/{categoryId}/move |
需要授权 |
POST |
/api/compliance/errors |
匿名 |
GET |
/api/compliance/reports |
需要授权 |
POST |
/api/compliance/reports |
匿名 |
GET |
/api/compliance/reports/mine |
需要授权 |
GET |
/api/compliance/reports/{contentReportId} |
需要授权 |
PUT |
/api/compliance/reports/{contentReportId} |
需要授权 |
POST |
/api/external-links/verify |
需要授权 |
GET |
/api/images/notes/{noteId} |
匿名 |
POST |
/api/images/notes/{noteId} |
需要授权 |
POST |
/api/images/profiles |
需要授权 |
GET |
/api/images/profiles/{userId} |
匿名 |
GET |
/api/images/teams/{teamId} |
匿名 |
POST |
/api/images/teams/{teamId} |
需要授权 |
GET |
/api/images/trackable-groups/{trackableGroupId} |
匿名 |
POST |
/api/images/trackable-groups/{trackableGroupId} |
需要授权 |
GET |
/api/images/trackables/{trackableId} |
匿名 |
POST |
/api/images/trackables/{trackableId} |
需要授权 |
DELETE |
/api/images/{contentImageId} |
需要授权 |
GET |
/api/images/{contentImageId}/{variant} |
匿名 |
GET |
/api/locations/mine/gpx |
需要授权 |
POST |
/api/locations/mine/gpx |
需要授权 |
GET |
/api/notes/mine |
需要授权 |
POST |
/api/notes/mine |
需要授权 |
GET |
/api/notes/mine/gpx |
需要授权 |
POST |
/api/notes/mine/gpx |
需要授权 |
DELETE |
/api/notes/mine/{noteId} |
需要授权 |
POST |
/api/notes/mine/{noteId}/move |
需要授权 |
GET |
/api/notes/public/bounds |
匿名 |
GET |
/api/notes/public/nearby |
匿名 |
GET |
/api/public/notes/{noteId} |
匿名 |
GET |
/api/public/notes/{noteId}/comments |
匿名 |
POST |
/api/public/notes/{noteId}/comments |
需要授权 |
GET |
/api/public/notes/{noteId}/trackables |
匿名 |
POST |
/api/public/notes/{noteId}/trackables |
需要授权 |
GET |
/api/public/profiles/{userName}/notes/nearby |
匿名 |
GET |
/api/public/teams/{teamName}/notes/nearby |
匿名 |
POST |
/api/sync/pull |
需要授权 |
POST |
/api/sync/push |
需要授权 |
GET |
/api/system/beta-android |
匿名 |
GET |
/api/system/coordinate-locality |
匿名 |
GET |
/api/system/ip-location |
匿名 |
GET |
/api/system/status |
匿名 |
GET |
/api/teams |
需要授权 |
POST |
/api/teams |
需要授权 |
POST |
/api/teams/invite-links/{teamSlug}/{inviteCode}/join |
需要授权 |
DELETE |
/api/teams/{teamId} |
需要授权 |
GET |
/api/teams/{teamId}/categories |
需要授权 |
POST |
/api/teams/{teamId}/categories |
需要授权 |
GET |
/api/teams/{teamId}/categories/tree |
需要授权 |
GET |
/api/teams/{teamId}/categories/tree/children |
需要授权 |
GET |
/api/teams/{teamId}/categories/tree/sections |
需要授权 |
DELETE |
/api/teams/{teamId}/categories/{categoryId} |
需要授权 |
POST |
/api/teams/{teamId}/categories/{categoryId}/move |
需要授权 |
GET |
/api/teams/{teamId}/invite-links |
需要授权 |
POST |
/api/teams/{teamId}/invite-links |
需要授权 |
DELETE |
/api/teams/{teamId}/invite-links/{inviteLinkId} |
需要授权 |
GET |
/api/teams/{teamId}/locations/gpx |
需要授权 |
POST |
/api/teams/{teamId}/locations/gpx |
需要授权 |
POST |
/api/teams/{teamId}/memberships/invite |
需要授权 |
POST |
/api/teams/{teamId}/memberships/request |
需要授权 |
DELETE |
/api/teams/{teamId}/memberships/{membershipId} |
需要授权 |
POST |
/api/teams/{teamId}/memberships/{membershipId}/accept |
需要授权 |
POST |
/api/teams/{teamId}/memberships/{membershipId}/approve |
需要授权 |
POST |
/api/teams/{teamId}/memberships/{membershipId}/deny |
需要授权 |
POST |
/api/teams/{teamId}/memberships/{membershipId}/promote-admin |
需要授权 |
POST |
/api/teams/{teamId}/memberships/{membershipId}/refuse |
需要授权 |
GET |
/api/teams/{teamId}/notes |
需要授权 |
POST |
/api/teams/{teamId}/notes |
需要授权 |
GET |
/api/teams/{teamId}/notes/gpx |
需要授权 |
POST |
/api/teams/{teamId}/notes/gpx |
需要授权 |
DELETE |
/api/teams/{teamId}/notes/{noteId} |
需要授权 |
DELETE |
/api/teams/{teamId}/notes/{noteId}/delete |
需要授权 |
POST |
/api/teams/{teamId}/notes/{noteId}/move |
需要授权 |
PUT |
/api/teams/{teamId}/settings |
需要授权 |
POST |
/api/trackables |
需要授权 |
GET |
/api/trackables/active |
匿名 |
GET |
/api/trackables/active-indicator |
匿名 |
DELETE |
/api/trackables/active/{trackableId} |
匿名 |
GET |
/api/trackables/active/{trackableId} |
匿名 |
POST |
/api/trackables/active/{trackableId}/deactivate |
匿名 |
POST |
/api/trackables/active/{trackableId}/message |
匿名 |
POST |
/api/trackables/groups |
需要授权 |
DELETE |
/api/trackables/groups/{trackableGroupId}/watch |
需要授权 |
POST |
/api/trackables/groups/{trackableGroupId}/watch |
需要授权 |
POST |
/api/trackables/legacy-lookup |
匿名 |
GET |
/api/trackables/lookup |
匿名 |
POST |
/api/trackables/lookup |
匿名 |
GET |
/api/trackables/mine |
需要授权 |
GET |
/api/trackables/public |
匿名 |
GET |
/api/trackables/{trackableId} |
匿名 |
POST |
/api/trackables/{trackableId}/activate |
需要授权 |
GET |
/api/trackables/{trackableId}/comments |
匿名 |
POST |
/api/trackables/{trackableId}/comments |
匿名 |
DELETE |
/api/trackables/{trackableId}/comments/{commentId} |
需要授权 |
PUT |
/api/trackables/{trackableId}/comments/{commentId} |
需要授权 |
DELETE |
/api/trackables/{trackableId}/group |
需要授权 |
POST |
/api/trackables/{trackableId}/group |
需要授权 |
GET |
/api/trackables/{trackableId}/journey |
匿名 |
POST |
/api/trackables/{trackableId}/journey-stops |
匿名 |
DELETE |
/api/trackables/{trackableId}/journey-stops/{journeyStopId} |
需要授权 |
DELETE |
/api/trackables/{trackableId}/watch |
需要授权 |
POST |
/api/trackables/{trackableId}/watch |
需要授权 |