تنظیم قانون sweep

PUT/v1/sweep-rules

قانون یک گروه را می‌نویسد. برای قانون اول base_version را 0 بفرستید و بعد نسخه‌ای را که جایگزین می‌شود. نسخه‌ی کهنه 409 است. API هرگز مقصد sweep را تعیین نمی‌کند؛ مقصد فقط از کنسول و با تأیید عوض می‌شود.

دسترسی لازم

sweep

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

120 برای هر کلید

درخواست

curl

curl -X PUT 'https://api.romu.ir/v1/sweep-rules' \
  -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 '{
    "group_id": "01926e00-0000-7000-8000-000000000201",
    "base_version": 0,
    "enabled": true,
    "schedule": {
      "kind": "interval",
      "every_hours": 6,
      "hours": [],
      "timezone": ""
    },
    "min_amounts": [
      {
        "asset": "TRON_TRX",
        "amount": "10"
      }
    ],
    "excluded_assets": []
  }'

TypeScript

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

const res = await romu.put("/v1/sweep-rules", {
  json: {
    "group_id": "01926e00-0000-7000-8000-000000000201",
    "base_version": 0,
    "enabled": true,
    "schedule": {
      "kind": "interval",
      "every_hours": 6,
      "hours": [],
      "timezone": ""
    },
    "min_amounts": [
      {
        "asset": "TRON_TRX",
        "amount": "10"
      }
    ],
    "excluded_assets": []
  },
});
console.log(res.status, res.body);

Go

status, body, err := client.Do("PUT", "/v1/sweep-rules", "", []byte(`{"group_id":"01926e00-0000-7000-8000-000000000201","base_version":0,"enabled":true,"schedule":{"kind":"interval","every_hours":6,"hours":[],"timezone":""},"min_amounts":[{"asset":"TRON_TRX","amount":"10"}],"excluded_assets":[]}`), "")

Python

import romu

status, body = romu.put(
    "/v1/sweep-rules",
    json={
      "group_id": "01926e00-0000-7000-8000-000000000201",
      "base_version": 0,
      "enabled": True,
      "schedule": {
        "kind": "interval",
        "every_hours": 6,
        "hours": [],
        "timezone": ""
      },
      "min_amounts": [
        {
          "asset": "TRON_TRX",
          "amount": "10"
        }
      ],
      "excluded_assets": []
    },
)
print(status, body)

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

بدنه

group_idUUIDلازم

base_versionintegerلازم

0 برای قانون اول، بعد نسخه‌ای که جایگزین می‌شود.

enabledbooleanلازم

scheduleobjectلازم

schedule.kindstringلازم

intervaldailymanual

schedule.every_hoursinteger

1 تا 24، فقط برای interval⁠.

schedule.hoursinteger[]

1 تا 24 ساعت از 0 تا 23، مرتب و بی تکرار، فقط برای daily⁠.

schedule.timezonestring

نام IANA، فقط برای daily⁠.

min_amountsobject[]

min_amounts[].assetstring

min_amounts[].amountstring

excluded_assetsstring[]

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

پاسخ

200قانون ثبت شد.

فیلدها

ruleobjectلازم

rule.wallet_idstring

rule.group_idstring

rule.groupstring

rule.enabledboolean

rule.scheduleobject

rule.schedule.kindstringلازم

intervaldailymanual

rule.schedule.every_hoursinteger

1 تا 24، فقط برای interval⁠.

rule.schedule.hoursinteger[]

1 تا 24 ساعت از 0 تا 23، مرتب و بی تکرار، فقط برای daily⁠.

rule.schedule.timezonestring

نام IANA، فقط برای daily⁠.

rule.min_amountsobject[]

rule.min_amounts[].assetstring

rule.min_amounts[].amountstring

rule.excluded_assetsstring[]

rule.versioninteger

rule.updated_atRFC 3339 | null

rule.last_run_atRFC 3339 | null

rule.next_run_atRFC 3339 | null

خطاها

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

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

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

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

409failed precondition⁠: این کار در وضعیت فعلی ممکن نیست.

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

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

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