ساخت گروه آدرس

POST/v1/address-groups

گروه تازه می‌سازد. نامی که در کیف پول هست 409 می‌گیرد. گروه هیچ‌وقت حذف نمی‌شود.

دسترسی لازم

addresses

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

60 برای هر کلید

درخواست

curl

curl -X POST 'https://api.romu.ir/v1/address-groups' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_id": "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
    "name": "users"
  }'

TypeScript

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

const res = await romu.post("/v1/address-groups", {
  json: {
    "wallet_id": "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
    "name": "users"
  },
});
console.log(res.status, res.body);

Go

status, body, err := client.Do("POST", "/v1/address-groups", "", []byte(`{"wallet_id":"0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12","name":"users"}`), "")

Python

import romu

status, body = romu.post(
    "/v1/address-groups",
    json={
      "wallet_id": "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
      "name": "users"
    },
)
print(status, body)

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

بدنه

wallet_idUUIDلازم

namestringلازم

فیلد ناشناخته در بدنه 400 می‌گیرد.

پاسخ

201گروه ساخته شد.

فیلدها

groupobjectلازم

group.idUUID

group.wallet_idUUID

group.namestring

group.statusstring

activearchived

group.created_atRFC 3339

خطاها

400invalid request یا malformed request body⁠: بدنه، پارامتر یا فیلد نادرست است، یا فیلد ناشناخته دارد.

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

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

404not found⁠: مسیر یا شیء پیدا نشد. خواندن کیف پولی بیرون از فهرست کلید هم همین است.

409already exists⁠: این نام پیش‌تر ثبت شده است.

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

503try again later⁠، org_paused (سازمان موقتاً متوقف شده، با Retry-After: 60⁠)، یا در ثبت برداشت suspension_unknown (با Retry-After: 5⁠). همان درخواست را با همان Idempotency-Key دوباره بفرستید.

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