Müşteriler API

Her müşteri için tek kayıt; tüm modüller aynı kaydı kullanır.

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

customers.add_address

Adres ekle — Kişinin adres defterine bir teslimat veya fatura adresi koyar.

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

• REST kısayolu: POST /api/v1/addresses
• Asıl adres: POST /api/v1/actions/customers.add_address

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.address_changed

Neye yazar: address (insert) — Writes the address; customer_address (upsert) — Links it to the person

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.address_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.addresses.create({
  id: "CUSTOMER_ID"
})

era addresses create \
  --id "CUSTOMER_ID"

{
  "name": "era__customers__add_address",
  "arguments": {
    "id": "CUSTOMER_ID"
  }
}

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

customers.add_identity

Bu kişiyi tanımanın bir yolunu ekle — Bir müşteri için başka bir e-posta, telefon, alan adı veya harici anahtar kaydeder.

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

• Asıl adres: POST /api/v1/actions/customers.add_identity

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.identity_changed

Neye yazar: customer_identity (insert) — Adds the key

curl -X POST https://app.getera.io/api/v1/customer_identities/actions/add_identity \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"CUSTOMER_ID","kind":"email","value":"Value"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.identity_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customerIdentities.addIdentity({
  id: "CUSTOMER_ID",
  kind: "email",
  value: "Value"
})

era customer_identities add_identity \
  --id "CUSTOMER_ID" \
  --kind "email" \
  --value "Value"

{
  "name": "era__customers__add_identity",
  "arguments": {
    "id": "CUSTOMER_ID",
    "kind": "email",
    "value": "Value"
  }
}

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

customers.add_my_address

Hesabıma adres ekle — Giriş yapmış müşteri, kendi adres defterine bir teslimat veya fatura adresi kaydeder.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/customers.add_my_address

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.address_changed

Neye yazar: address (insert) — The address; customer_address (insert) — In their own book

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

customers.archive

Müşteriyi arşivle — Hiçbir şeyi silmeden kaydı listelerden ve seçicilerden çıkarır.

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

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

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.archived

Neye yazar: customer (update) — Stamps archived_at

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

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

import { createEra } from "@getera/sdk"

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

era customers archive CUSTOMER_ID

{
  "name": "era__customers__archive",
  "arguments": {
    "id": "CUSTOMER_ID"
  }
}

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

customers.capture

Müşteri ekle veya tanı — Bir e-posta veya telefon numarasını tek bir müşteri kaydına bağlar; yalnızca yeniyse oluşturur.

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

• REST kısayolu: POST /api/v1/customers
• Asıl adres: POST /api/v1/actions/customers.capture

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.created, customers.recognised

Neye yazar: customer (upsert) — Creates the customer when the identity is new; customer_identity (upsert) — Records every way this person reaches you

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

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

import { createEra } from "@getera/sdk"

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

era customers create \
  --name "Name"

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

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

customers.capture_site_guest

Web alıcısını tanı — Ödemenin iletişim adımı: giriş yapmış müşteri ya da e-postasıyla tanınan misafir; teslimat adresi bu siparişin kendi kopyası olarak yazılır.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/customers.capture_site_guest

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.recognised, customers.created

Neye yazar: customer (insert) — A new guest, when the email is not known; address (insert) — The delivery address, as the order’s own copy

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

customers.confirm_email_change

Yeni e-postamı onayla — Yeni gelen kutusuna gelen kod, site hesabını ve müşteri kaydını o adrese taşır.

Gereken izin customers:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/customers.confirm_email_change

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.login_changed, customers.updated

Neye yazar: customer_login_code (update) — Counts the attempt or uses the code up; customer_login (update) — Moves the sign-in to the new address; customer (update) — Their record gets the new address

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

customers.disable_login

Site hesabını kapat — Müşterinin web sitenize girişini durdurur ve tüm cihazlarda oturumunu kapatır. Kaydı ve geçmişi korunur.

Gereken izin customers: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

• Asıl adres: POST /api/v1/actions/customers.disable_login

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.login_changed

Neye yazar: customer_login (update) — Switched off, with the reason; customer_session (update) — Every open session revoked

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.login_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customerLogins.disableLogin({
  id: "CUSTOMER_ID"
})

era customer_logins disable_login \
  --id "CUSTOMER_ID"

{
  "name": "era__customers__disable_login",
  "arguments": {
    "id": "CUSTOMER_ID"
  }
}

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

customers.enable_login

Site hesabını yeniden aç — Müşterinin web sitenize yeniden giriş yapmasına izin verir.

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

• Asıl adres: POST /api/v1/actions/customers.enable_login

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.login_changed

Neye yazar: customer_login (update) — Switched back on

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.login_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customerLogins.enableLogin({
  id: "CUSTOMER_ID"
})

era customer_logins enable_login \
  --id "CUSTOMER_ID"

{
  "name": "era__customers__enable_login",
  "arguments": {
    "id": "CUSTOMER_ID"
  }
}

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

customers.export

Müşterileri dışa aktar — Filtrelenmiş hâliyle müşteri listesi; müşteriler ekranı bunu CSV veya Excel dosyasına dönüştürür.

Gereken izin customers:export · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.exported

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.exported"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("customers.export", {
  q: "Search"
})

era run customers.export \
  --q "Search"

{
  "name": "era__customers__export",
  "arguments": {
    "q": "Search"
  }
}

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

customers.merge

İki müşteriyi birleştir — Bir kaydı diğerine katar; kimliklerini ve geçmişini taşır.

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

• Asıl adres: POST /api/v1/actions/customers.merge

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.merged

Neye yazar: customer (update) — Tombstones the merged record and applies the chosen values; customer_identity (update) — Moves identities to the survivor; customer_address (update) — Moves the address book to the survivor

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.merged"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customers.merge("CUSTOMER_ID", {
  mergeId: "CUSTOMER_ID"
})

era customers merge CUSTOMER_ID \
  --merge-id "CUSTOMER_ID"

{
  "name": "era__customers__merge",
  "arguments": {
    "keepId": "CUSTOMER_ID",
    "mergeId": "CUSTOMER_ID"
  }
}

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

customers.remove_address

Adresi arşivle — Adresi, onu kullanan belgelere dokunmadan defterden çıkarır.

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

• Asıl adres: POST /api/v1/actions/customers.remove_address

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.address_changed

Neye yazar: address (update) — Stamps archived_at; customer_address (update) — Clears the defaults

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.address_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.addresses.removeAddress("ADDRESSE_ID")

era addresses remove_address ADDRESSE_ID

{
  "name": "era__customers__remove_address",
  "arguments": {
    "addressId": "ADDRESSE_ID"
  }
}

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

customers.remove_identity

Bu kişiyi tanıma yolunu kaldır — Bir anahtarı bırakır; geriye kalan tek anahtar değilse.

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

• Asıl adres: POST /api/v1/actions/customers.remove_identity

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.identity_changed

Neye yazar: customer_identity (delete) — Removes the key

curl -X POST https://app.getera.io/api/v1/customer_identities/actions/remove_identity \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"CUSTOMER_ID","kind":"email","value":"Value"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.identity_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customerIdentities.removeIdentity({
  id: "CUSTOMER_ID",
  kind: "email",
  value: "Value"
})

era customer_identities remove_identity \
  --id "CUSTOMER_ID" \
  --kind "email" \
  --value "Value"

{
  "name": "era__customers__remove_identity",
  "arguments": {
    "id": "CUSTOMER_ID",
    "kind": "email",
    "value": "Value"
  }
}

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

customers.remove_my_address

Hesabımdan adresi kaldır — Giriş yapmış müşteri, kendi adres defterinden bir adresi çıkarır.

Gereken izin customers:write · siler ya da geri alınamaz · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/customers.remove_my_address

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.address_changed

Neye yazar: address (update) — Archived — orders that used it keep their copy; customer_address (update) — No longer a default

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

customers.request_email_change

Giriş e-postamı değiştir — Giriş yapmış müşteri başka bir adresle giriş yapmak ister; adresin kendisine ait olduğunu kanıtlaması için o adrese bir kod gider.

Gereken izin customers:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/customers.request_email_change

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.sign_in_code_requested

Neye yazar: customer_login_code (insert) — Stores the hash of a ten-minute change code

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

customers.request_sign_in_code

Giriş kodu gönder — Ziyaretçinin siteye girmek için yazacağı altı haneli bir kodu e-postayla gönderir; şifre gerekmez.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/customers.request_sign_in_code

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.sign_in_code_requested

Neye yazar: customer_login_code (insert) — Stores the hash of a ten-minute code

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

customers.restore

Müşteriyi geri yükle — Arşivlenmiş bir kaydı geri getirir.

Gereken izin customers:delete · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/customers.restore

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.restored

Neye yazar: customer (update) — Clears archived_at

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.restored"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customers.restore("CUSTOMER_ID")

era customers restore CUSTOMER_ID

{
  "name": "era__customers__restore",
  "arguments": {
    "id": "CUSTOMER_ID"
  }
}

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

customers.send_sign_in_link

Site giriş bağlantısı gönder — Müşteriye web sitenize giriş yapması için bir bağlantı e-postayla gönderir; ilk seferde ya da giriş yapamadığında. Kendi kodunu orada alır.

Gereken izin customers:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.sign_in_link_sent

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.sign_in_link_sent"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("customers.send_sign_in_link", {
  id: "CUSTOMER_ID"
})

era run customers.send_sign_in_link \
  --id "CUSTOMER_ID"

{
  "name": "era__customers__send_sign_in_link",
  "arguments": {
    "id": "CUSTOMER_ID"
  }
}

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

customers.set_default_address

Varsayılan adresi belirle — Aksi söylenmedikçe teslimat veya fatura için hangi adresin kullanılacağı.

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

• Asıl adres: POST /api/v1/actions/customers.set_default_address

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.address_default_changed

Neye yazar: customer_address (update) — Moves the default

curl -X POST https://app.getera.io/api/v1/customer_addresses/actions/set_default_address \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"CUSTOMER_ID","addressId":"ADDRESS_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.address_default_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customerAddresses.setDefaultAddress({
  id: "CUSTOMER_ID",
  addressId: "ADDRESS_ID"
})

era customer_addresses set_default_address \
  --id "CUSTOMER_ID" \
  --address-id "ADDRESS_ID"

{
  "name": "era__customers__set_default_address",
  "arguments": {
    "id": "CUSTOMER_ID",
    "addressId": "ADDRESS_ID"
  }
}

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

customers.set_my_password

Şifremi belirle — Giriş yapmış müşteri, site hesabının şifresini belirler veya değiştirir.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/customers.set_my_password

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.login_changed

Neye yazar: customer_login (update) — Stores the scrypt hash of the password

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

customers.set_parent

Bir şirkete bağla — Bu kişinin hangi şirkete ait olduğunu belirtir ya da bağlantıyı kaldırır.

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

• Asıl adres: POST /api/v1/actions/customers.set_parent

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.parent_changed

Neye yazar: customer (update) — Sets the company link

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.parent_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.customers.setParent("CUSTOMER_ID", {
  parentId: "CUSTOMER_ID"
})

era customers set_parent CUSTOMER_ID \
  --parent-id "CUSTOMER_ID"

{
  "name": "era__customers__set_parent",
  "arguments": {
    "id": "CUSTOMER_ID",
    "parentId": "CUSTOMER_ID"
  }
}

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

customers.sign_in_with_password

Şifreyle giriş yap — Müşteriyi hesabında belirlediği şifreyle siteye giriş yaptırır.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/customers.sign_in_with_password

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.signed_in

Neye yazar: customer_session (insert) — A thirty-day site session; customer_login (update) — Last sign-in

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

customers.sign_out

Çıkış yap — Müşterinin bu cihazdaki site oturumunu kapatır.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (customer)

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.signed_out

Neye yazar: customer_session (update) — Revoked

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

customers.update

Müşteriyi düzenle — Kişinin bilgilerini değiştirir ve sistemin geri kalanına bildirir.

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

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

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.updated

Neye yazar: customer (update) — Updates the record

curl -X POST https://app.getera.io/api/v1/customers/CUSTOMER_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": [
    "customers.updated"
  ]
}

import { createEra } from "@getera/sdk"

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

era customers update CUSTOMER_ID \
  --name "Name"

{
  "name": "era__customers__update",
  "arguments": {
    "id": "CUSTOMER_ID",
    "name": "Name"
  }
}

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

customers.update_address

Adresi düzenle — Defterdeki bir adresi değiştirir. Bir belgede dondurulmuş kopya değişmez.

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

• Asıl adres: POST /api/v1/actions/customers.update_address

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.address_changed

Neye yazar: address (update) — Updates the address; customer_address (update) — Updates its label

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

{
  "ok": true,
  "result": "…",
  "events": [
    "customers.address_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.addresses.updateAddress("ADDRESSE_ID", {
  label: "Label"
})

era addresses update_address ADDRESSE_ID \
  --label "Label"

{
  "name": "era__customers__update_address",
  "arguments": {
    "addressId": "ADDRESSE_ID",
    "label": "Label"
  }
}

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

customers.update_my_profile

Bilgilerimi güncelle — Giriş yapmış müşteri kendi adını, telefonunu ve dilini düzeltir.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/customers.update_my_profile

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.updated

Neye yazar: customer (update) — Their own record

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

customers.verify_sign_in_code

Kodla giriş yap — E-postayla gelen kodu doğrular ve ziyaretçiyi içeri alır; ilk seferde hesabını açar ve işletmenin zaten tanıdığı müşteriye bağlar.

Gereken izin customers:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/customers.verify_sign_in_code

Girdi

Ön koşullar

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

Yayımladığı olaylar: customers.signed_in, customers.sign_in_failed, customers.login_created, customers.created, customers.recognised

Neye yazar: customer_login_code (update) — Counts the attempt or uses the code up; customer_login (upsert) — Makes the login the first time; marks the email verified; customer (insert) — A new customer when nobody with this email is known; customer_identity (insert) — The email, as a way of recognising them; customer_session (insert) — A thirty-day site session

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

Veri modelleri

Address

Tablo address · Kaynak addresses

• GET /api/v1/addresses
• GET /api/v1/addresses/{id}
• POST /api/v1/addresses → customers.add_address

Birincil anahtar: id

Denetimler:

• CHECK ((COALESCE(street_address_1, city, postal_code, raw, company_name) IS NOT NULL))
• CHECK ((NOT (is_snapshot AND (archived_at IS NOT NULL))))

CustomerAddress

Tablo customer_address · Kaynak customer_addresses

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

Birincil anahtar: id

Tekil: customer_id, address_id

CustomerIdentity

Tablo customer_identity · Kaynak customer_identities

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

Birincil anahtar: id

Denetimler:

• CHECK (( CASE kind WHEN 'email'::text THEN (value = lower(value)) WHEN 'domain'::text THEN (value = lower(value)) ELSE true END AND (value = btrim(value)) AND (length(value) > 0)))

CustomerLoginCode

Tablo customer_login_code · Kaynak customer_login_codes

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

Birincil anahtar: id

CustomerLogin

Tablo customer_login · Kaynak customer_logins

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

Birincil anahtar: id

Denetimler:

• CHECK (((email IS NOT NULL) OR (phone IS NOT NULL)))
• CHECK (((email IS NULL) OR ((email = lower(btrim(email))) AND (POSITION(('@'::text) IN (email)) > 1))))
• CHECK (((disabled_reason IS NULL) OR (length(disabled_reason) <= 500)))

Customer

Tablo customer · Kaynak customers

• GET /api/v1/customers
• GET /api/v1/customers/{id}
• POST /api/v1/customers → customers.capture
• PATCH /api/v1/customers/{id} → customers.update
• DELETE /api/v1/customers/{id} → customers.archive

Birincil anahtar: id

Olaylar

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