Құжаттама мәтіні әзірге орыс тілінде. Қазақша аудармасы дайындалып жатыр — мәзір мен түймелер қазақша.

API анықтамалығы

Atasu Maps API анықтамалығы openapi.yaml спецификациясынан автоматты түрде жасалады. Сипаттамалар ағылшын тілінде.

Спецификация 1.0.0-draft.1: 26 операция қолжетімді, 15 жоспарланған.

Map sessions & styles

Map session, tile token and style JSON. Tile token format is in the `TileToken` security scheme.

POST/v1/map-sessionsStart a map session and get a tile tokenҚолжетімді
POST/v1/map-sessions/{session_id}/tokensRefresh the tile token of a live sessionҚолжетімді
GET/v1/styles/{style_id}.jsonMapLibre style JSONҚолжетімді

Vector tiles on tiles.atasumaps.com. Served by Martin / traffic-edge, not by apps/api.

GET/v1/basemap/{z}/{x}/{y}.mvtBasemap vector tile (OSM + Overture, ODbL)Қолжетімді
GET/v1/canopy/{z}/{x}/{y}.mvtTree canopy height classes (Meta & WRI, CC BY 4.0), Almaty and AstanaҚолжетімді
GET/v1/overlay/{z}/{x}/{y}.mvtApproved crowdsourced places and entrancesҚолжетімді
GET/v1/reports/{z}/{x}/{y}.mvtLive road events (z ≥ 10)Қолжетімді
GET/v1/fonts/{fontstack}/{range}.pbfGlyph range of a font stack (the style's `glyphs` URL)Қолжетімді
GET/v1/sprites/{sprite_file}Sprite sheet image or index (the style's `sprite` URL)Қолжетімді
GET/v1/native-styles/{style_file}Static style for MapLibre Native (one theme, Kazakh labels)Қолжетімді
GET/v1/native-styles/patches/{patch_file}Theme or language patch for a native styleҚолжетімді
GET/v1/traffic/tiles.jsonTileJSON for the traffic flow source (zoom range, coverage, TomTom attribution)Қолжетімді
GET/v1/traffic/{z}/{x}/{y}.pbfTraffic flow tile (TomTom through the budgeted proxy)Қолжетімді

Autocomplete, address search, reverse geocoding with entrances.

GET/v1/geocode/autocompleteType-ahead suggestions (kk / ru / en, mixed Cyrillic and Latin)Қолжетімді
GET/v1/geocode/searchFull-text and structured address / place searchҚолжетімді
GET/v1/geocode/reverseCoordinates → address and nearest entranceҚолжетімді

Place details with entrances.

Route, ETA, matrix, map matching, pickup points.

POST/v1/routeDriving / walking route with alternatives and turn-by-turn stepsҚолжетімді
POST/v1/etaFixed-route live travel time (for quotes)Жоспарланған
POST/v1/matrixSources × targets travel-time matrix (dispatch)Жоспарланған
POST/v1/snapMap-match a GPS trace to roadsЖоспарланған
POST/v1/pickup-pointsRecommended pickup points — stairwell entrances, compound gates, legal stopsЖоспарланған

Live road events and "still there / gone" votes.

POST/v1/reportsReport a road eventҚолжетімді
POST/v1/reports/{report_id}/votesVote "still there" / "gone" on an eventҚолжетімді

Crowdsourced places, entrances and fixed cameras. Never pre-filled from OSM.

POST/v1/places/submissionsSubmit a new place, a place edit, an entrance or a fixed cameraҚолжетімді

The signed-in user — profile, devices, my submissions, appeals, deletion, rewards.

GET/v1/meCurrent userҚолжетімді
PATCH/v1/meUpdate display name or localeЖоспарланған
POST/v1/me/devicesRegister this deviceЖоспарланған
GET/v1/me/submissionsMy submissions and reports with their statusҚолжетімді
GET/v1/me/submissions/{report_id}One of my submissions, with status historyҚолжетімді
POST/v1/me/submissions/{report_id}/withdrawWithdraw a pending submissionЖоспарланған
POST/v1/me/submissions/{report_id}/appealAppeal a rejected submission (once)Қолжетімді
POST/v1/me/submissions/{report_id}/mediaAttach a photo to my submissionЖоспарланған
GET/v1/me/deletion-requestStatus of my deletion requestЖоспарланған
POST/v1/me/deletion-requestRequest deletion of my dataЖоспарланған
GET/v1/me/rewardsMy jarmaq grant history (Beta; off until its tests pass)Жоспарланған

Partner fleet positions and passenger trip sharing.

POST/v1/fleet/positionsPublish vehicle positions (HTTP alternative to the stream `pub` op)Жоспарланған
POST/v1/tripsStart sharing a trip (vehicle ↔ passenger)Жоспарланған
POST/v1/trips/{trip_id}/ticketsIssue a short-lived passenger ticket for a tripЖоспарланған
POST/v1/trips/{trip_id}/endEnd a trip; tickets stop working and subscribers get a tombstoneЖоспарланған

WebSocket endpoint; protocol in packages/openapi/WEBSOCKET.md.