API & belgeler

Tek anahtar. Her modül.

Çoğu iş yazılımı, ürün başına bir API sunar — biri kasa için, diğeri stok için, üçüncüsü faturalar için; her birinin kendi kimlik doğrulaması ve kendi tarih anlayışı vardır. Kardopal'ın tek bir API'si var. Aynı anahtar, aynı temel URL ve aynı sorgu grameri, 29 modülde 129 kaynağa ulaşır.

API anahtarı oluştur Nereye ulaştığını görün
29
Modüller
129
Kaynaklar
1
Anahtar, tek bir temel URL
200
Sayfa başına satır, maks.

Bu API üzerine neden geliştirme yapılmalı

Burada doğru olan ve genellikle olmayan altı şey.

Kendini açıklar

Temel URL'ye eriştiğinizde API kendi kataloğunu döndürür — anahtarınızın görebileceği her modül, içindeki her kaynak, hangi alanların aranabilir ve hangilerinin filtrelenebilir olduğu. Entegrasyonu yazmak için bu sayfaya ihtiyacınız yok; buna karar vermek için ihtiyacınız var.

Gerçekten kısıtlayan izinler

Uygulamadaki kapsamlar, rotalar ve izin etiketleri tek bir listeden oluşturulur, bu nedenle arkasında bir uç nokta olmadıkça bir izin sunulamaz. Kapsamlı bir anahtar öğeler öğeleri alır — ondan bordro istemek 403 döndürür, sessiz boş bir sayfa değil.

Her yerde tek bir sorgu dilbilgisi

arama, itibaren, kadar, atla ve al faturalarda ve stok hareketlerinde aynı anlama gelir. Yapıyı bir kez öğrenin, 133 kaynağın her biri buna göre yanıt verir.

Sizin kiracınız, sadece sizin.

Her tablo bir kiracı kimliği taşır ve her sorgu, veritabanına ulaşmadan önce anahtarın kendi kiracısına göre kapsamlandırılır. Yanlış gidebilecek bir kiracılar arası okuma yoktur, çünkü bunu isteyebilecek bir parametre bulunmamaktadır.

Alanlar kendini doğrular

Alan listesi, elle tutulmak yerine başlangıçta canlı şemadan okunur. Yeni bir sütun kendiliğinden görünür; kaldırılan bir sütun, belgelerde asla asılı bir referans veya ilk çağrıda 500 hatası bırakmaz.

Sadece okunabilir, bilerek

Anahtarlar okur; asla yazmazlar. Yanlış giden bir entegrasyon bir faturayı geçersiz kılamaz veya stok hareket ettiremez. Bir kaydı değiştiren her şey, bir kişiye atfedildiği ve denetim günlüğüne düştüğü uygulama veya personel girişi üzerinden gerçekleşir.

Tek bir istekte başla

Her şey bir GET isteğidir. Eğer kullanabiliyorsanız curl, bunu kullanabilirsiniz.

GET /api/v1Anahtarınızın görebileceği tüm katalog
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meSağlamlık kontrolü — bu anahtar kime ait ve ne okuyabilir?
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Her kaynak, aynı biçim
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsKaynak başına satır sayısı — hangi verilerin gerçekten mevcut olduğunu görün
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Beş parametre

ParametreYaptıklarıNotlar
aramaKaynağın aranabilir alanlarında büyük/küçük harf duyarsız eşleşmeBu alanlar şurada listelenmiştir /meta
itibarenSadece bu tarihten sonraki kayıtlarKaynağın sıraladığı alana uygulanır
kadarSadece bu tarihe kadar olan kayıtlarBirleştir itibaren bir pencere için
atlaSonuç kümesine ofsetVarsayılan olarak 0
alDöndürülecek satır sayısıVarsayılan 50, üst sınır 200

Kaynaklar, kendi tanımlanmış alanlarında tam eşleşme filtrelerini de kabul eder — ?durum=ödendi, ?warehouseId=… — ve her biri bunların hangileri olduğunu duyurur. Her liste yanıtı taşır toplam ve dahaFazlaVar, böylece sayfalama bir döngüdür, bir tahmin değil.

API'nin erişebildikleri

29 modül, 129 kaynak. Her kart, bir anahtara verebileceğiniz bir izindir — ve gri etiket, aynı kayıtların telefonunuzdaki uygulamada bulunduğu yerdir.

Kişiler

2

Müşteriler, tedarikçiler ve bulundukları segmentler.

kişileriletişim-segmentleri
kişiler Kişiler

Ürünler

7

Katalog: ürünler, varyantlar, markalar, fiyat listeleri ve birimler.

öğelerkategorilermarkalarürün-varyantlarıfiyat-listeleribirimler+1 daha
öğeler Ürünler

Envanter

7

Depolar, stok seviyeleri, hareketler, partiler, seri numaraları ve raflar.

depolarstok-hareketleristok-seviyeleripartilerseri numaralarıstok sayımları+1 daha
envanter Envanter

Satış

7

Faturalar, teklifler, siparişler, iade faturaları ve ödemeler.

faturalartahminlersatış-siparişleriiade-faturalarıödemeleryinelenen faturalar+1 daha
satış Satış

POS

11

Kasalar, vardiyalar, makbuzlar, masalar ve tezgahtan geçen her satış.

pos-satışlarıpos-vardiyalarıpos-terminalleripos-usersPOS masalarıpos-masa-alanları+5 daha
pos POS

CRM

4

Potansiyel müşteriler, anlaşmalar, satış süreçleri ve teklifler.

potansiyel müşterileranlaşmalariş akışlarıteklifler
crm CRM

Satın Alma

5

Satın alma siparişleri, talepler, iadeler, faturalar ve satıcı ödemeleri.

satın alma siparişlerisatın-alma-taleplerisatın alma iadelerifaturalarsatıcı ödemeleri
satın alma Satın Alma

Muhasebe

5

Giderler, banka hesapları, işlemler ve vergi oranları.

giderlergider-kategorileribanka-hesaplarıbank-transactionstax-rates
muhasebe Muhasebe

Pazarlama

4

Kampanyalar, alıcılar, açılış sayfaları ve form gönderimleri.

kampanyalarkampanya-alıcılarıaçılış-sayfalarıform gönderimleri
pazarlama Pazarlama

HR

8

Personel, departmanlar, izinler, maaş bordroları, katılım ve işe alım.

çalışanlardepartmanlarleave-requestsmaaş bordrolarıKatılımiş-ilanları+2 daha
hr HR

Zaman çizelgesi

2

Zaman girişleri ve ilişkilendirildikleri projeler.

zaman-girişlerizaman-çizelgesi-projeleri
zaman çizelgesi Zaman çizelgesi

Projeler

3

Projeler, aşamalar ve bunlara bağlı maliyetler.

projelerproje-aşamalarıproje-maliyetleri
projeler Projeler

Rezervasyon

3

Randevular, rezerve edilebilir hizmetler ve bunları sunan personel.

rezervasyonlarrezervasyon-hizmetleripersonel-rezervasyonları
rezervasyon Rezervasyon

Saha Servisi

7

İşler, teknisyenler, iş emirleri, sözleşmeler ve ekipman.

field-jobsteknisyenlerhizmet-taleplerihizmet sözleşmeleriiş-emirleriiş-kartları+1 daha
saha_servisi Saha Servisi

Lojistik

5

Sevkiyatlar, sürücüler, araçlar, bölgeler ve taşıyıcılar.

sevkiyatlarsürücüleraraçlarteslimat-bölgeleritaşıyıcılar
lojistik Lojistik

Yardım Masası

5

Talepler, SLA politikaları, yardım makaleleri ve bilgi tabanı.

taleplermüşteri-biletleriyardım-makaleleribilgi tabanısla-politikaları
destek Yardım Masası

Satış Sonrası

5

İadeler, garanti talepleri, onarımlar ve ürün kayıtları.

rmasgaranti-taleplerigaranti-kayıtlarıtamirlerürün-kayıtları
satış_sonrası Satış Sonrası

Kiralama

3

Kiralanabilir varlıklar, kiralama sözleşmeleri ve kalemleri.

varlıklarkiralamalarkiralama-satırları
kiralama Kiralama

Restoran

2

Menü ve ona verilen siparişler.

menu-itemsmenü-siparişleri
restoran Yiyecek & İçecek

Sıra

5

Biletler, hizmetler, sayaçlar, şubeler ve ekranlar.

sıra-fişlerisıra-hizmetlerisıra-sayaçlarıkuyruk-şubelerisıra-ekranları
kuyruk Sıra

Sadakat

6

Üyeler, hesaplar, seviyeler, ödüller ve puan işlemleri.

loyalty-memberssadakat-hesaplarısadakat-ödüllerisadakat-seviyelerisadakat-işlemlerisadakat kuponları
sadakat Sadakat

Konumlar

2

Siteler ve şubeler.

konumlarşubeler
konumlar Konumlar

IOT

6

Cihazlar, siteler, kutular, uyarılar, etkinlikler ve tabela içerikleri.

iot-cihazlarıiot-sitesiot-uyarılarıiot-olaylarıiot-boxesiot-tabela-içeriği
iot IOT Hub

Yapay Zeka Stüdyosu

3

Oluşturulan varlıklar, bunları içeren projeler ve iş geçmişi.

ai-assetsyapay-zeka-projeleriai-jobs
ai_studio Yapay Zeka Stüdyosu

Ticaret

3

Ağ üyeleri, teklif talepleri ve tahsilatlar.

ağ-üyelerifiyat-teklifi-taleplerikoleksiyonlar
ticaret Ticaret

e-İmza

2

İmza talepleri ve bunlara karşılık toplanan imzalar.

imza talepleriimzalar
imza e-İmza

Onaylar

2

Onay talepleri ve bunları yönlendiren kurallar.

onay-isteklerionay kuralları
onaylar Onaylar

Dosyalar

2

Yüklenen dosyalar ve taranmış belgeler.

dosyalartaranmış-belgeler
dosyalar Dosyalar

Etkinlik

3

Etkinlik akışı, denetim kaydı ve bildirimler.

aktivitelerdenetim-kayıtlarıBildirimler
Telefonda

API'nin okuduğu her modülü ekibiniz elinde açabilir

Bu kısım genellikle doğru değildir. Birçok platform geniş bir API sunar ve ardından üç şey yapan bir mobil uygulama yayınlar — onayla, görüntüle, bildir. Kardopal’ın uygulaması bir yardımcı değil, ürünün kendisidir: yukarıdaki 29 modülün tamamı gerçek ekranlara sahiptir ve işin çoğu aslında telefonda gerçekleşir.

  • Okuyun, sonra harekete geçin. Entegrasyonunuz bir stok seviyesi çeker; düzeltmesi gereken kişi aynı kaydı açar, ayarlar ve kendi adına imzalar.
  • Tara, çek, imzala. Barkod tarama, belge yakalama ve e-imza telefona özgüdür — kullanmaya değer bir masaüstü karşılığı yoktur.
  • Kasada çevrimdışı toleranslı. Bağlantı kesintiye uğradığında kasa, mutfak ekranı ve sıra göstergesi çalışmaya devam eder.
  • Aynı giriş, aynı veri, 20 dil. Sağdan sola diller dahil, böylece Arapça konuşan bir ekip yansıtılmış bir düzen okumaz.
Platformu görün
Telefonda çalışan Kardopal uygulaması

Bir anahtar almak

Uygulamayı açın, Platform → API Anahtarları'na gidin.Anahtarlar, kendi kiracınızda bir sahip veya yönetici tarafından oluşturulur. Kardopal'da hiç kimse sizin için anahtar düzenlemez.
Entegrasyonun ihtiyaç duyduğu modülleri işaretleyin.Bir vitrin widget'ı şunları gerektirir öğeler. İhtiyaç duymaz hr. Dar anahtarlar güvenli bir şekilde başarısız olur.
Başlık olarak gönderin, asla URL'de değil.X-API-Key: kp_live_… — sorgu dizeleri günlüklerde, proxy'lerde ve tarayıcı geçmişinde son bulur.
Önce yeni anahtarı oluşturarak döndürün.Her ikisi de aynı anda çalışır, böylece trafiği aktarabilir ve eskiyi kesinti olmadan iptal edebilirsiniz.

Üzerine kurun

API kendini belgeler: uygulamada bir anahtar oluşturun, yönlendirin curl temel URL'de ve bu anahtarın erişebileceği her modülü, kaynağı ve aranabilir alanı geri döndürür.

API anahtarı oluştur