Resources API

Rooms, pitches, cars, chairs and equipment people book — by the hour or by the day.

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

resources.archive

Arşivle — Yeni rezervasyonları durdurur. Mevcut olanlar olduğu gibi kalır.

Gereken izin resources:manage · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/resources/{id}
• Asıl adres: POST /api/v1/actions/resources.archive

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.archived

Neye yazar: resource (update) — Stamps archived_at

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

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.archived"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resources.archive("RESOURCE_ID")

era resources archive RESOURCE_ID

{
  "name": "era__resources__archive",
  "arguments": {
    "id": "RESOURCE_ID"
  }
}

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

resources.book

Kaynak rezerve et — Bir sahada bir saat ya da bir odada dokuz gece; o zaman zaten doluysa reddedilir.

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

• REST kısayolu: POST /api/v1/resource_bookings
• Asıl adres: POST /api/v1/actions/resources.book

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.booked

Neye yazar: resource_booking (insert) — Books it

curl -X POST https://app.getera.io/api/v1/resource_bookings/actions/book \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"resourceId":"RESOURCE_ID","startsAt":"From (local, YYYY-MM-DDTHH:mm)","endsAt":"Until (local, YYYY-MM-DDTHH:mm)"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.booked"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resourceBookings.create({
  resourceId: "RESOURCE_ID",
  startsAt: "From (local, YYYY-MM-DDTHH:mm)",
  endsAt: "Until (local, YYYY-MM-DDTHH:mm)"
})

era resource_bookings create \
  --resource-id "RESOURCE_ID" \
  --starts-at "From (local, YYYY-MM-DDTHH:mm)" \
  --ends-at "Until (local, YYYY-MM-DDTHH:mm)"

{
  "name": "era__resources__book",
  "arguments": {
    "resourceId": "RESOURCE_ID",
    "startsAt": "From (local, YYYY-MM-DDTHH:mm)",
    "endsAt": "Until (local, YYYY-MM-DDTHH:mm)"
  }
}

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

resources.book_weekly

Her hafta ayır — Aboneliğin dönemi bitene kadar her hafta aynı gün ve saat; ya tüm haftalar ya hiçbiri.

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

• Asıl adres: POST /api/v1/actions/resources.book_weekly

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.series_booked

Neye yazar: resource_booking (insert) — Books every week of the period

curl -X POST https://app.getera.io/api/v1/resource_bookings/actions/book_weekly \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"resourceId":"RESOURCE_ID","subscriptionId":"SUBSCRIPTION_ID","startsAt":"First week from (local)","endsAt":"First week until (local)"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.series_booked"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resourceBookings.bookWeekly({
  resourceId: "RESOURCE_ID",
  subscriptionId: "SUBSCRIPTION_ID",
  startsAt: "First week from (local)",
  endsAt: "First week until (local)"
})

era resource_bookings book_weekly \
  --resource-id "RESOURCE_ID" \
  --subscription-id "SUBSCRIPTION_ID" \
  --starts-at "First week from (local)" \
  --ends-at "First week until (local)"

{
  "name": "era__resources__book_weekly",
  "arguments": {
    "resourceId": "RESOURCE_ID",
    "subscriptionId": "SUBSCRIPTION_ID",
    "startsAt": "First week from (local)",
    "endsAt": "First week until (local)"
  }
}

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

resources.cancel_booking

Rezervasyonu iptal et — Zamanı boşaltır. Haftalık bir seride, isteğe bağlı olarak kalan tüm haftaları da.

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

• Asıl adres: POST /api/v1/actions/resources.cancel_booking

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.booking_cancelled

Neye yazar: resource_booking (update) — Marks it cancelled

curl -X POST https://app.getera.io/api/v1/resource_bookings/RESOURCE_BOOKING_ID/actions/cancel_booking \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.booking_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resourceBookings.cancelBooking("RESOURCE_BOOKING_ID", {
  reason: "Reason"
})

era resource_bookings cancel_booking RESOURCE_BOOKING_ID \
  --reason "Reason"

{
  "name": "era__resources__cancel_booking",
  "arguments": {
    "id": "RESOURCE_BOOKING_ID",
    "reason": "Reason"
  }
}

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

resources.create

Kaynak ekle — İnsanların rezervasyon yaptığı bir oda, saha, araç, koltuk veya ekipman.

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

• REST kısayolu: POST /api/v1/resources
• Asıl adres: POST /api/v1/actions/resources.create

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.created

Neye yazar: resource (insert) — Adds the resource

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

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resources.create({
  name: "Name"
})

era resources create \
  --name "Name"

{
  "name": "era__resources__create",
  "arguments": {
    "name": "Name"
  }
}

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

resources.set_services

Bu kaynağı gerektiren hizmetleri belirle — Bu kaynakla birlikte alınan hizmetler. Böyle bir hizmet için randevu alınırken randevu sihirbazı boş bir kaynak ister.

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

• Asıl adres: POST /api/v1/actions/resources.set_services

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.services_changed

Neye yazar: resource_service (upsert) — Replaces the list of services that need it

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

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.services_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resourceServices.setServices({
  id: "RESOURCE_ID"
})

era resource_services set_services \
  --id "RESOURCE_ID"

{
  "name": "era__resources__set_services",
  "arguments": {
    "id": "RESOURCE_ID"
  }
}

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

resources.update

Kaynağı düzenle — Ad, tür, kapasite, saatler ve zaman aralığı uzunluğu. Mevcut rezervasyonlar olduğu gibi kalır.

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

• REST kısayolu: PATCH /api/v1/resources/{id}
• Asıl adres: POST /api/v1/actions/resources.update

Girdi

Ön koşullar

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

Yayımladığı olaylar: resources.updated

Neye yazar: resource (update) — Updates the resource

curl -X POST https://app.getera.io/api/v1/resources/RESOURCE_ID/actions/update \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "resources.updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.resources.update("RESOURCE_ID", {
  name: "Name"
})

era resources update RESOURCE_ID \
  --name "Name"

{
  "name": "era__resources__update",
  "arguments": {
    "id": "RESOURCE_ID",
    "name": "Name"
  }
}

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

Veri modelleri

ResourceBooking

Tablo resource_booking · Kaynak resource_bookings

• GET /api/v1/resource_bookings
• GET /api/v1/resource_bookings/{id}
• POST /api/v1/resource_bookings → resources.book

Birincil anahtar: id

Denetimler:

• CHECK ((ends_at > starts_at))

ResourceService

Tablo resource_service · Kaynak resource_services

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

Birincil anahtar: id

Tekil: resource_id, item_id

Resource

Tablo resource · Kaynak resources

• GET /api/v1/resources
• GET /api/v1/resources/{id}
• POST /api/v1/resources → resources.create
• PATCH /api/v1/resources/{id} → resources.update
• DELETE /api/v1/resources/{id} → resources.archive

Birincil anahtar: id

Denetimler:

• CHECK (((capacity >= 1) AND (capacity <= 1000)))
• CHECK (((slot_minutes = 1440) OR (closes_at > opens_at)))
• CHECK ((length(TRIM(BOTH FROM name)) > 0))
• CHECK (((slot_minutes >= 5) AND (slot_minutes <= 1440)))

Olaylar

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