Diller API

Çalıştığınız ve yayın yaptığınız diller ile çevirileriniz.

Modül kodu i18n · 4 işlem · 2 veri modeli · 4 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ı: i18n (hepsi), i18n:read (yalnız okuma) ya da i18n:<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

i18n.add_language

Dil ekle — Bu çalışma alanının içeriği başka bir dilde de tutmasını sağlar.

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

• Asıl adres: POST /api/v1/actions/i18n.add_language

Girdi

Ön koşullar

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

Yayımladığı olaylar: i18n.language_added, i18n.default_language_changed

Neye yazar: workspace_language (insert) — Adds the language to the workspace

curl -X POST https://app.getera.io/api/v1/workspace_languages/actions/add_language \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"code":"Language code","label":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "i18n.language_added",
    "i18n.default_language_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.workspaceLanguages.addLanguage({
  code: "Language code",
  label: "Name"
})

era workspace_languages add_language \
  --code "Language code" \
  --label "Name"

{
  "name": "era__i18n__add_language",
  "arguments": {
    "code": "Language code",
    "label": "Name"
  }
}

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

i18n.remove_language

Dili kaldır — Bir dili geri çeker ve o dilde yazılanları siler.

Gereken izin i18n:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/i18n.remove_language

Girdi

Ön koşullar

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

Yayımladığı olaylar: i18n.language_removed

Neye yazar: workspace_language (delete) — Removes the language; translation (delete) — Deletes everything written in it

curl -X POST https://app.getera.io/api/v1/workspace_languages/actions/remove_language \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"code":"Language"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "i18n.language_removed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.workspaceLanguages.removeLanguage({
  code: "Language"
})

era workspace_languages remove_language \
  --code "Language"

{
  "name": "era__i18n__remove_language",
  "arguments": {
    "code": "Language"
  }
}

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

i18n.set_default_language

Varsayılan dili değiştir — Çevrilmemiş bir kaydın düştüğü dil.

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

• Asıl adres: POST /api/v1/actions/i18n.set_default_language

Girdi

Ön koşullar

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

Yayımladığı olaylar: i18n.default_language_changed

Neye yazar: workspace_language (update) — Moves the default to this language

curl -X POST https://app.getera.io/api/v1/workspace_languages/actions/set_default_language \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"code":"Language"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "i18n.default_language_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.workspaceLanguages.setDefaultLanguage({
  code: "Language"
})

era workspace_languages set_default_language \
  --code "Language"

{
  "name": "era__i18n__set_default_language",
  "arguments": {
    "code": "Language"
  }
}

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

i18n.set_translation

Kaydı çevir — Bir kaydın çevrilebilir alanlarını tek bir dilde kaydeder.

Gereken izin i18n:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/i18n.set_translation

Girdi

Ön koşullar

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

Yayımladığı olaylar: i18n.translated

Neye yazar: translation (update) — Writes the translated fields

curl -X POST https://app.getera.io/api/v1/translations/actions/set_translation \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"entity_type":"Kind of record","entity_id":"ENTITY_ID","language_code":"Language","values":"Fields"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "i18n.translated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.translations.setTranslation({
  entity_type: "Kind of record",
  entity_id: "ENTITY_ID",
  language_code: "Language",
  values: "Fields"
})

era translations set_translation \
  --entity-type "Kind of record" \
  --entity-id "ENTITY_ID" \
  --language-code "Language" \
  --values "Fields"

{
  "name": "era__i18n__set_translation",
  "arguments": {
    "entity_type": "Kind of record",
    "entity_id": "ENTITY_ID",
    "language_code": "Language",
    "values": "Fields"
  }
}

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

Veri modelleri

Translation

Tablo translation · Kaynak translations

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

Birincil anahtar: id

Tekil: workspace_id, entity_type, entity_id, language_code

Denetimler:

• CHECK ((jsonb_typeof("values") = 'object'::text))

WorkspaceLanguage

Tablo workspace_language · Kaynak workspace_languages

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

Birincil anahtar: workspace_id, code

Denetimler:

• CHECK ((code ~ '^[a-z]{2}(-[A-Za-z0-9]{2,8})?$'::text))

Olaylar

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