Құжаттама мәтіні әзірге орыс тілінде. Қазақша аудармасы дайындалып жатыр — мәзір мен түймелер қазақша.
Me
The signed-in user — profile, devices, my submissions, appeals, deletion, rewards.
← Барлық операциялар
GET/v1/meҚолжетімді
- Хост
https://api.atasumaps.com · getMe- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
Only what the map side stores — map reputation, trust level, locale. No phone, real name, wallet data
or Atasuai sub. Staff consoles read the caller's role here:
trust_level moderator / admin (the token carries no roles claim; two-factor sign-in is still
proven by the token's amr / acr). A banned user gets 403. Like every /v1 user route it needs an
API key (any scope) as well as the user token; staff consoles use a web key of their own.
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Profile | Me |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
PATCH/v1/meЖоспарланған
- Хост
https://api.atasumaps.com · updateMe- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
- Idempotency-Key
- Міндетті: әр команда үшін бір кілт, қайталау бірінші нәтижені қайтарады
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
Idempotency-Key | header | string | иә | Client-generated unique key per logical command (UUID v4/v7 recommended). Scope: caller + endpoint + key. Same key + same body → first result (Idempotent-Replayed: true); same key + different body → 409 idempotency_key_reused. Missing → 400 idempotency_key_required. Keys are kept at least 24 hours. |
Сұрау денесі MeUpdate
| Атауы | Түрі | Міндетті | Сипаттама |
|---|
display_name | string | null | | |
locale | Lang | | |
expected_version | integer | | |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Updated profile | Me |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
409 | Conflict — never a silent overwrite. Codes: idempotency_key_reused (same key, different body), version_conflict (stale expected_version; body has current_version), invalid_state (transition not allowed from the current status), appeal_already_used, base_version_stale (place changed since the edit's baseline; rebase first), later_edits_exist (revert needs compensation), already_claimed, last_owner, already_member, deletion_pending. A retry with the original Idempotency-Key still returns the original result, never a 409. | Problem |
POST/v1/me/devicesЖоспарланған
- Хост
https://api.atasumaps.com · registerDevice- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
- Idempotency-Key
- Міндетті: әр команда үшін бір кілт, қайталау бірінші нәтижені қайтарады
Returns the device_id sent with event reports. Attestation (Play Integrity / App Attest) is optional in the MVP and only raises
weight later. Push tokens are not accepted until push providers outside Kazakhstan are
legally approved.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
Idempotency-Key | header | string | иә | Client-generated unique key per logical command (UUID v4/v7 recommended). Scope: caller + endpoint + key. Same key + same body → first result (Idempotent-Replayed: true); same key + different body → 409 idempotency_key_reused. Missing → 400 idempotency_key_required. Keys are kept at least 24 hours. |
Сұрау денесі DeviceRegister
| Атауы | Түрі | Міндетті | Сипаттама |
|---|
platform | "android" | "ios" | "web" | иә | |
app_version | string | | |
attestation_token | string | | Play Integrity / App Attest token; verified server-side, not stored |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
201 | Device registered (or the same device returned on replay) | Device |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
409 | Conflict — never a silent overwrite. Codes: idempotency_key_reused (same key, different body), version_conflict (stale expected_version; body has current_version), invalid_state (transition not allowed from the current status), appeal_already_used, base_version_stale (place changed since the edit's baseline; rebase first), later_edits_exist (revert needs compensation), already_claimed, last_owner, already_member, deletion_pending. A retry with the original Idempotency-Key still returns the original result, never a 409. | Problem |
GET/v1/me/submissionsҚолжетімді
- Хост
https://api.atasumaps.com · listMySubmissions- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
kind | query | ReportKind[] | | |
status | query | SubmissionDisplayStatus[] | | |
lang | query | Lang | | Response language; overrides Accept-Language. Default kk (Cyrillic). |
cursor | query | string | | Opaque cursor from the previous page's next_cursor. |
limit | query | integer | | |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Page of submissions, newest first | MySubmissionPage |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
GET/v1/me/submissions/{report_id}Қолжетімді
- Хост
https://api.atasumaps.com · getMySubmission- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
report_id | path | string (uuid) | иә | |
lang | query | Lang | | Response language; overrides Accept-Language. Default kk (Cyrillic). |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Submission | MySubmissionDetail |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
404 | No such resource, or not visible to the caller (not_found) | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
POST/v1/me/submissions/{report_id}/withdrawЖоспарланған
- Хост
https://api.atasumaps.com · withdrawMySubmission- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
- Idempotency-Key
- Міндетті: әр команда үшін бір кілт, қайталау бірінші нәтижені қайтарады
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
report_id | path | string (uuid) | иә | |
Idempotency-Key | header | string | иә | Client-generated unique key per logical command (UUID v4/v7 recommended). Scope: caller + endpoint + key. Same key + same body → first result (Idempotent-Replayed: true); same key + different body → 409 idempotency_key_reused. Missing → 400 idempotency_key_required. Keys are kept at least 24 hours. |
Сұрау денесі ExpectedVersionOnly
| Атауы | Түрі | Міндетті | Сипаттама |
|---|
expected_version | integer | иә | |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Withdrawn | CommandResult |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
404 | No such resource, or not visible to the caller (not_found) | Problem |
409 | Conflict — never a silent overwrite. Codes: idempotency_key_reused (same key, different body), version_conflict (stale expected_version; body has current_version), invalid_state (transition not allowed from the current status), appeal_already_used, base_version_stale (place changed since the edit's baseline; rebase first), later_edits_exist (revert needs compensation), already_claimed, last_owner, already_member, deletion_pending. A retry with the original Idempotency-Key still returns the original result, never a 409. | Problem |
POST/v1/me/submissions/{report_id}/appealҚолжетімді
- Хост
https://api.atasumaps.com · appealMySubmission- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
- Idempotency-Key
- Міндетті: әр команда үшін бір кілт, қайталау бірінші нәтижені қайтарады
rejected → pending_review, at most once per submission
(409 appeal_already_used). Re-approval of a new place re-enables the original place; an edit
is first rebased by a moderator. Someone else's submission → 404. Through this endpoint a
moderator is an ordinary reporter (moderator re-opening only via the admin API).
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
report_id | path | string (uuid) | иә | |
Idempotency-Key | header | string | иә | Client-generated unique key per logical command (UUID v4/v7 recommended). Scope: caller + endpoint + key. Same key + same body → first result (Idempotent-Replayed: true); same key + different body → 409 idempotency_key_reused. Missing → 400 idempotency_key_required. Keys are kept at least 24 hours. |
Сұрау денесі AppealCreate
| Атауы | Түрі | Міндетті | Сипаттама |
|---|
reason | string | иә | |
expected_version | integer | иә | |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Back in the review queue | CommandResult |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
404 | No such resource, or not visible to the caller (not_found) | Problem |
409 | Conflict — never a silent overwrite. Codes: idempotency_key_reused (same key, different body), version_conflict (stale expected_version; body has current_version), invalid_state (transition not allowed from the current status), appeal_already_used, base_version_stale (place changed since the edit's baseline; rebase first), later_edits_exist (revert needs compensation), already_claimed, last_owner, already_member, deletion_pending. A retry with the original Idempotency-Key still returns the original result, never a 409. | Problem |
429 | Rate limit (rate_limited) or monthly plan quota (quota_exceeded: reject plans only; Retry-After = seconds until the next Asia/Almaty month; context = product, included, used, period_end) | Problem |
POST/v1/me/submissions/{report_id}/mediaЖоспарланған
- Хост
https://api.atasumaps.com · uploadSubmissionPhoto- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
- Idempotency-Key
- Міндетті: әр команда үшін бір кілт, қайталау бірінші нәтижені қайтарады
Stored in object storage inside Kazakhstan. Size and type limited, content scanned, EXIF and
location stripped before any publication; the original is kept separately and only moderators
can see it, with every view logged. Max 10 MB, JPEG / PNG / HEIC, 5 photos per submission.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
report_id | path | string (uuid) | иә | |
Idempotency-Key | header | string | иә | Client-generated unique key per logical command (UUID v4/v7 recommended). Scope: caller + endpoint + key. Same key + same body → first result (Idempotent-Replayed: true); same key + different body → 409 idempotency_key_reused. Missing → 400 idempotency_key_required. Keys are kept at least 24 hours. |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
201 | Stored | MediaRef |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |
404 | No such resource, or not visible to the caller (not_found) | Problem |
409 | Conflict — never a silent overwrite. Codes: idempotency_key_reused (same key, different body), version_conflict (stale expected_version; body has current_version), invalid_state (transition not allowed from the current status), appeal_already_used, base_version_stale (place changed since the edit's baseline; rebase first), later_edits_exist (revert needs compensation), already_claimed, last_owner, already_member, deletion_pending. A retry with the original Idempotency-Key still returns the original result, never a 409. | Problem |
413 | payload_too_large | Problem |
415 | unsupported_media_type | Problem |
GET/v1/me/deletion-requestЖоспарланған
- Хост
https://api.atasumaps.com · getDeletionRequest- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Request | DeletionRequest |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
404 | No such resource, or not visible to the caller (not_found) | Problem |
POST/v1/me/deletion-requestЖоспарланған
- Хост
https://api.atasumaps.com · requestDeletion- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
- Idempotency-Key
- Міндетті: әр команда үшін бір кілт, қайталау бірінші нәтижені қайтарады
Covers the primary database, search index, photos and caches; backups expire by policy.
Approved public contributions are kept but detached from the account (draft — see open
questions). Replays return the existing request.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
Idempotency-Key | header | string | иә | Client-generated unique key per logical command (UUID v4/v7 recommended). Scope: caller + endpoint + key. Same key + same body → first result (Idempotent-Replayed: true); same key + different body → 409 idempotency_key_reused. Missing → 400 idempotency_key_required. Keys are kept at least 24 hours. |
Сұрау денесі DeletionRequestCreate
| Атауы | Түрі | Міндетті | Сипаттама |
|---|
confirm | true | иә | |
reason | string | | |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
202 | Request recorded | DeletionRequest |
400 | Invalid request (invalid_request, idempotency_key_required, limit_exceeded, future_departure_not_supported, observation_in_future) | Problem |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
409 | Conflict — never a silent overwrite. Codes: idempotency_key_reused (same key, different body), version_conflict (stale expected_version; body has current_version), invalid_state (transition not allowed from the current status), appeal_already_used, base_version_stale (place changed since the edit's baseline; rebase first), later_edits_exist (revert needs compensation), already_claimed, last_owner, already_member, deletion_pending. A retry with the original Idempotency-Key still returns the original result, never a 409. | Problem |
GET/v1/me/rewardsЖоспарланған
- Хост
https://api.atasumaps.com · listMyRewards- Рұқсат
- Кез келген API кілті + кірген пайдаланушы (Atasuai)
- Есепке алу
- Тегін
The Atasuai wallet is the ledger of record; this lists the map side's grant records only. Returns 403 feature_disabled until rewards are switched on.
Параметрлер
| Атауы | Қайда | Түрі | Міндетті | Сипаттама |
|---|
cursor | query | string | | Opaque cursor from the previous page's next_cursor. |
limit | query | integer | | |
Жауаптар
| Мәртебе | Сипаттама | Түрі |
|---|
200 | Grants, newest first | RewardGrantPage |
401 | Missing or invalid credentials (unauthenticated, key_invalid, key_revoked, token_expired, token_invalid) | Problem |
403 | Authenticated but not allowed (scope_denied, key_restriction_failed, forbidden, user_banned, mfa_required, self_moderation_forbidden, feature_disabled) | Problem |