API Kaynakları

9 görüntülenme Markdown

Uçlar nasıl gruplanır, bir grup ile bir eylem nasıl izin adına dönüşür ve aradığınızı nasıl bulursunuz.

Genel Bakış

API tabloya göre değil kaynağa göre düzenlenmiştir. Kaynak, ürünün bir alanıdır: müşteriler, faturalar, hizmetler, ürünler, talepler. İçindeki her eylem, yapabileceğiniz tek bir iştir.

Bu ikili, API'nin bütün adlandırma sistemi. Clients/GetClients aynı anda rotanın kimliği, anahtar verirken işaretlediğiniz izin, 403 mesajındaki metin ve dokümanın kullandığı ad. Birini öğrenince gerisini bilirsiniz.

Eylemler bilerek fiil gibi okunur: Get, Create, Update, Delete, Bulk. HTTP metodu fiille uyuşur; ad ile metot size hiçbir zaman farklı şey söylemez.

Yapı

Yönetim adresi kaynaklarını ailelere ayırır. Bir entegrasyon için nadiren birden fazla aile gerekir; bu ayrım verdiğiniz izinler için de doğal sınırdır.

system · reference Sağlık, anahtar kimliği ve diğer her çağrının alanlarını doldurduğu listeler: para birimleri, ülkeler, eyaletler, şehirler, diller, faturalama döngüleri, durumlar.

clients · admins · affiliates Müşteri kayıtları; adresleri, grupları, belgeleri ve erişimleriyle birlikte. Yanında personel hesapları ve satış ortaklığı programı.

orders · invoices · financial · services Para yolunun tamamı: sipariş faturaya, ödenmiş fatura hizmete dönüşür ve hizmet yenilenir.

products · modules Sattığınız şey ve onu kuran şey: fiyatlandırması, ek hizmetleri ve gereksinimleriyle ürünler, arkalarındaki modül kaydı.

tickets · knowledgebase · website Departmanlar ve talep trafiği, yayımlanmış makaleler, herkese açık sitenin sayfaları ve menüleri.

settings · automation · languages · notifications · tools Kurulumun kendi düzeneği: yapılandırma, zamanlanmış işler, dil paketleri, bildirim şablonları ve bakım araçları.

Müşteri adresi çok daha kısa bir liste taşır, çünkü müşteri bir kurulumu değil tek bir hesabı yönetir. Kendi makalesinde anlatılıyor.

Aradığınız Ucu Bulmak

Yukarıdan aşağı gidin. Aileyi seçin, bu bölümdeki referans makalesini açın ve eylem listesini okuyun; her kayıt metodu, yolu, izin adını ve dört dilde çalışan bir örnek verir.

Nesneyi biliyor ama aileyi bilmiyorsanız ad genellikle ele verir. Müşterinin kendi kaydıyla ilgili her şey clients içinde; üzerinde fiyat olan her şey invoices ya da orders içinde; bir sunucuda çalışan her şey services içinde.

Örnek

Zaten kurulumun içinde çalışan koda HTTP, anahtar ya da ağ turu gerekmez. Aynı kaynağı süreç içinde çağırabilir ve aynı zarfı alır.

aynı eylem, iki yol

// HTTP üzerinden:  GET /api/v1/admin/clients?limit=5
// süreç içinde: bir modülden, bir cron isleyicisinden ya da bir kanca dinleyicisinden
$result = \WISECP\Api\Kernel::internal('Clients/GetClients', [], ['limit' => 5]);

$clients = $result['data']  ?? [];
$total   = $result['meta']['total'] ?? 0;

// müsteri adresine, hangi hesap adina davrandigi soylenmelidir
$me = \WISECP\Api\Kernel::internal('client:Account/GetMe', ['owner_id' => 42]);

Tuzaklar

Kaynak bir tablo değildir

Müşteri oluşturmak birden çok tabloya yazar, kancaları çalıştırır ve bildirim gönderebilir. Müşteri okumak ise ayrı yerlerde duran kayıtları birleştirir. Kolon-alan eşleşmesi beklemek sizi yanıltır; şemayı değil eylemin alan listesini okuyun.

Kurulu modüller kendi gruplarını ekleyebilir

Bir modül Module:{Tip}/{Ad} adlı bir grup altında uç yayımlayabilir. Bunlar kendi izin kutularıyla görünür ve diğer uçlar gibi davranır, ama o modüle aittir ve onunla birlikte gelir. Kurulumun kendi kataloğunun parçası değildirler; birine dayanan bir entegrasyon hangi modüle ihtiyaç duyduğunu söylemelidir.

Faydalı oldu mu?

Geri bildiriminiz için teşekkürler!

Hâlâ Yardıma mı İhtiyacınız Var?

Yukarıda bulamadığınız her şey için destek ekibimiz her zaman yanınızda.

Bize Ulaşın Destek Talebi Oluştur