کلید عمومی Webhook

GET/v1/webhooks/key

کلیدهای عمومی امضای Webhook، هر کدام با نسخه‌اش. آن‌ها را نگه دارید و اگر X-Custody-Key-Version ناشناخته‌ای رسید، این مسیر را دوباره بخوانید.

دسترسی لازم

read

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

120 برای هر کلید

درخواست

curl

curl 'https://api.romu.ir/v1/webhooks/key' \
  -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/webhooks/key");
console.log(res.status, res.body);

Go

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

Python

import romu

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

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

پاسخ

200کلیدها.

نمونه

{
  "keys": [
    {
      "key_version": 1,
      "public_key": "VSX1y38XE3pPle9xXdo8QY98yVtH+PNMoZFPlX5Jt5o="
    }
  ]
}

فیلدها

keysobject[]لازم

keys[].key_versioninteger

keys[].public_keystring

base64 استاندارد 32 بایت.

خطاها

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

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

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

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

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