API başvurusu

Entegratörün çağırabileceği tüm uçlar: Veri API (/api/v1/…, firma API anahtarı) ve imzalı gelen webhook (/hooks/…). Sayfalar ürünün OpenAPI şemasından (sürüm 0.1.0) üretilir; yollar, alanlar, türler ve sınırlar çalışan API ile aynıdır.

Temel adres: konsol adresinizdir, ör. https://<konsol-adresiniz>. Örneklerde $RZ_API, anahtar $RZ_KEY olarak geçer.

export RZ_API="https://<konsol-adresiniz>"
export RZ_KEY="rz_live_xxx"

Uçlar

Yöntem	Yol	Kapsam
GET	/api/v1/me	—
PUT	/api/v1/catalog/products	ingest:catalog
DELETE	/api/v1/catalog/products/{item_ref}	ingest:catalog
PUT	/api/v1/catalog/categories	ingest:catalog
DELETE	/api/v1/catalog/categories/{kategori_id}	ingest:catalog
PUT	/api/v1/kb/articles	ingest:kb
PUT	/api/v1/orders	ingest:orders
GET	/api/v1/requests	read:requests
PUT	/api/v1/sepetler	ingest:carts
GET	/api/v1/sepetler	read:carts
DELETE	/api/v1/sepetler/{dis_id}	ingest:carts
PUT	/api/v1/musteriler	ingest:customers
DELETE	/api/v1/musteriler/{dis_id}	ingest:customers
GET	/api/v1/cagrilar	calls:read
GET	/api/v1/cagrilar/{call_id}	calls:read
GET	/api/v1/konular/istatistik	calls:read
POST	/api/v1/aramalar	calls:write
GET	/api/v1/aramalar/{arama_id}	calls:read ya da calls:write
GET	/api/v1/amaclar	calls:write
POST	/api/v1/buton-token	calls:write
PUT	/api/v1/uyumluluk	ingest:catalog
PUT	/api/v1/servis-kayitlari/{kayit}/durum	servis:write
POST	/api/v1/servis-kayitlari/{kayit}/onay	servis:write
GET	/api/v1/firsatlar	firsat:read
GET	/api/v1/firsatlar/{lead_id}	firsat:read
GET	/api/v1/raporlar/cagri-kayitlari	rapor:read
GET	/api/v1/raporlar/{rapor}/gunluk	rapor:read
POST	/api/v1/sohbet-token	sohbet:write
POST	/hooks/{org_slug}/{source}	HMAC imza

Gömülebilir butonun tarayıcı uçları (GET /api/v1/buton/amaclar, POST /api/v1/buton/aramalar, GET /api/v1/zitena-buton.js) OpenAPI şemasında yer almaz; bunları betiğin kendisi çağırır ve buton sayfasında anlatılır.

Neler dahil değil

Bir uç yalnız firma API anahtarıyla (FirmaApiAnahtari güvenlik şeması) ya da webhook imzasıyla kimlik doğruluyorsa dahildir. Geri kalanlar dahil edilmedi:

Grup	İşlem
altyapı sağlık denetimi	1
konsol oturumu uçları (çerezle kimlik), yalnız web konsolu kullanır	378
platform işletmecisi (süper admin) uçları	86
tanıtım sitesi ve konsol kabuğu için açık uçlar	9

Konsol özellikleri (ayarlar, webhook’lar, API anahtarları, arayüzdeki çağrılar) API ucu olarak değil konsol rehberi olarak anlatılır: bu uçlar oturum açmış bir konsol kullanıcısı ister ve kararlı bir entegrasyon sözleşmesi değildir.

Makinece okunur şema bu belgelerle birlikte yayımlanır: /openapi/public.json.