Ayarlar API

İşletmeniz, bu çalışma alanı ve her modül için ayarlar.

Modül kodu settings · 1 işlem · 2 veri modeli · 1 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: settings (hepsi), settings:read (yalnız okuma) ya da settings:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

settings.set

Ayarı değiştir — Organizasyon, çalışma alanı veya modül katmanında tek bir ayarı yazar.

Gereken izin settings:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/settings.set

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: settings.changed

Neye yazar: setting (upsert) — Writes the setting

curl -X POST https://app.getera.io/api/v1/settings/actions/set \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"layer":"organization","key":"Key","value":"Value"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "settings.changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.settings.set({
  layer: "organization",
  key: "Key",
  value: "Value"
})

era settings set \
  --layer "organization" \
  --key "Key" \
  --value "Value"

{
  "name": "era__settings__set",
  "arguments": {
    "layer": "organization",
    "key": "Key",
    "value": "Value"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde settings:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 module_required, unknown_setting, invalid_value · 429 çok sık istek

Veri modelleri

NumberSequence

Tablo number_sequence · Kaynak number_sequences

• GET /api/v1/number_sequences
• GET /api/v1/number_sequences/{id}

Birincil anahtar: id

Tekil: workspace_id, code

Setting

Tablo setting · Kaynak settings

• GET /api/v1/settings
• GET /api/v1/settings/{id}

Birincil anahtar: id

Denetimler:

• CHECK (((module_code IS NULL) OR (workspace_id IS NOT NULL)))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.