این کلید کیست

GET/v1/whoami

سازمان، شناسه و دسترسی‌های همین کلید و کیف پول‌هایش را برمی‌گرداند. بهترین مسیر برای آزمودن امضا است.

دسترسی لازم

read

سقف نرخ در دقیقه

120 برای هر کلید

درخواست

curl

curl 'https://api.romu.ir/v1/whoami' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE"

TypeScript

import { romu } from "./romu.ts";

const res = await romu.get("/v1/whoami");
console.log(res.status, res.body);

Go

status, body, err := client.Get("/v1/whoami", "")

Python

import romu

status, body = romu.get(
    "/v1/whoami",
)
print(status, body)

امضای درخواست را کتابخانه انجام می‌دهد؛ جزئیات: صفحه‌ی امضا

پاسخ

200اطلاعات کلید.

نمونه

{
  "org_id": "0192f1a0-7c3e-7b42-9d1e-5a8b3c6d2e10",
  "key_id": "01926e60-0000-7000-8000-000000000001",
  "scopes": [
    "read",
    "withdraw"
  ],
  "allowed_wallet_ids": [
    "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12"
  ],
  "all_wallets": false
}

فیلدها

org_idUUIDلازم

شناسه‌ی سازمان.

key_idUUIDلازم

scopesstring[]لازم

allowed_wallet_idsUUID[]لازم

کیف پول‌های این کلید.

all_walletsbooleanلازم

کلید به همه‌ی کیف پول‌ها دسترسی دارد. فقط برای کلید بی دسترسی نوشتن ممکن است.

خطاها

401unauthenticated⁠: هر شکست احراز هویت همین پاسخ را دارد.

403permission denied⁠: کلید دسترسی این مسیر را ندارد.

429too many requests⁠: بیش از سقف نرخ. پس از Retry-After ثانیه دوباره بفرستید.

503try again later⁠: سرویس موقتاً در دسترس نیست.

بدنه‌ی خطا همیشه {"error":"..."} است. راهنمای خطاها می‌گوید برای هر کد چه باید کرد.