API & dokumen

Satu kunci. Setiap modul.

Sebagian besar perangkat lunak bisnis memberi Anda API per produk — satu untuk kasir, satu lagi untuk stok, yang ketiga untuk faktur, masing-masing dengan otentikasi dan format tanggalnya sendiri. Kardopal hanya memiliki satu. Kunci yang sama, URL dasar yang sama, dan tata bahasa kueri yang sama dapat mengakses 129 sumber daya di 29 modul.

Buat kunci API Lihat jangkauannya
29
Modul
129
Sumber daya
1
Kunci, satu URL dasar
200
Baris per halaman, maks

Mengapa API ini layak untuk dikembangkan

Enam hal yang benar di sini dan biasanya tidak.

Ini menjelaskan dirinya sendiri

Akses URL dasar dan API akan mengembalikan katalognya sendiri — setiap modul yang dapat dilihat kunci Anda, setiap sumber daya di dalamnya, bidang mana yang dapat dicari dan mana yang dapat difilter. Anda tidak memerlukan halaman ini untuk menulis integrasi; Anda memerlukannya untuk memutuskan.

Izin yang benar-benar membatasi

Cakupan, rute, dan izin di aplikasi dihasilkan dari satu daftar, sehingga izin tidak dapat ditawarkan kecuali ada endpoint di baliknya. Kunci yang dicakupkan ke item mendapatkan item — meminta data penggajian mengembalikan 403, bukan halaman kosong tanpa pemberitahuan.

Satu tata bahasa kueri, di mana saja

cari, sejak, hingga, lewati dan Ambil berarti hal yang sama pada faktur seperti pada pergerakan stok. Pelajari bentuknya sekali dan setiap 133 sumber daya akan mengikutinya.

Penyewa Anda, dan hanya milik Anda

Setiap tabel membawa ID penyewa dan setiap kueri dicakup ke penyewa kunci itu sendiri sebelum mencapai basis data. Tidak ada pembacaan lintas-penyewa yang bisa salah, karena tidak ada parameter yang bisa memintanya.

Bidang-bidang menjaga integritasnya sendiri

Daftar kolom dibaca dari skema langsung saat boot, bukan dikelola secara manual. Kolom baru muncul dengan sendirinya; kolom yang dihapus tidak akan pernah meninggalkan referensi yang menggantung di dokumen atau menghasilkan error 500 pada panggilan pertama.

Hanya-baca, disengaja

Kunci hanya membaca; tidak pernah menulis. Integrasi yang salah tidak dapat membatalkan faktur atau memindahkan stok. Apa pun yang mengubah catatan melalui aplikasi atau login staf, di mana itu diatribusikan kepada seseorang dan masuk ke log audit.

Mulai dalam satu permintaan

Semuanya adalah GET. Jika Anda bisa menggunakan curl, Anda bisa menggunakan ini.

GET /api/v1Seluruh katalog yang dapat dilihat kunci Anda
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/mePemeriksaan kewarasan — kunci siapa ini, dan apa yang bisa dibaca
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Sumber daya apa pun, bentuk yang sama
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsJumlah baris per sumber daya — lihat data apa yang benar-benar ada
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Lima parameter

ParameterMelakukanCatatan
cariPencocokan tidak peka huruf besar-kecil di seluruh bidang yang dapat dicari dari sumber dayaBidang-bidang tersebut tercantum dalam /meta
sejakHanya catatan mulai dari tanggal iniBerlaku untuk bidang tempat sumber daya diurutkan
hinggaHanya catatan hingga tanggal iniGabungkan dengan sejak untuk jendela
lewatiOffset ke dalam set hasilDefault ke 0
AmbilBerapa banyak baris yang akan dikembalikanStandar 50, maksimal 200

Sumber daya juga menerima filter pencocokan persis pada bidang yang dideklarasikan sendiri — ?status=dibayar, ?warehouseId=… — dan masing-masing mengiklankan yang mana. Setiap respons daftar membawa Total dan adaLagi, sehingga penomoran halaman adalah sebuah perulangan, bukan tebakan.

Apa yang dijangkau API

29 modul, 129 sumber daya. Setiap kartu adalah satu izin yang dapat Anda berikan ke kunci — dan tag abu-abu adalah tempat catatan yang sama berada di aplikasi di ponsel Anda.

Kontak

2

Pelanggan, pemasok, dan segmen tempat mereka berada.

kontaksegmen-kontak
kontak Kontak

Item

7

Katalog: produk, varian, merek, daftar harga, dan unit.

itemkategorimerekVarian itemdaftar hargaunit+1 lainnya
item Item

Inventaris

7

Gudang, tingkat stok, pergerakan, batch, serial, dan tempat penyimpanan.

gudangpergerakan-stoktingkat-stokbatchserialspenghitungan-stok+1 lainnya
inventaris Inventaris

Penjualan

7

Faktur, perkiraan, pesanan, nota kredit, dan pembayaran.

fakturestimasipesanan-penjualannota-kreditPembayaranfaktur-berulang+1 lainnya
Penjualan Penjualan

POS

11

Kasir, shift, tanda terima, meja, dan setiap penjualan yang melewati konter.

penjualan-posShift POSterminal-pospengguna-posmeja-posarea-meja-pos+5 lainnya
pos POS

CRM

4

Prospek, kesepakatan, pipeline, dan proposal.

prospekdealssaluranproposal
crm CRM

Pembelian

5

Pesanan pembelian, permintaan, retur, tagihan, dan pembayaran vendor.

pesanan-pembelianpermintaan-pembelianretur-pembelianTagihanpembayaran-vendor
pembelian Pembelian

Akuntansi

5

Pengeluaran, rekening bank, transaksi, dan tarif pajak.

pengeluarankategori-pengeluaranrekening-banktransaksi-banktarif-pajak
akuntansi Akuntansi

Pemasaran

4

Kampanye, penerima, halaman arahan, dan pengiriman formulir.

kampanyecampaign-recipientshalaman-arahanpengajuan formulir
pemasaran Pemasaran

HR

8

Karyawan, departemen, cuti, slip gaji, kehadiran, dan perekrutan.

karyawandepartemenpermintaan-cutiSlip gajikehadiranlowongan-pekerjaan+2 lainnya
hr HR

Lembar waktu

2

Entri waktu dan proyek yang terkait dengannya.

entri-waktuproyek lembar waktu
lembar-waktu Lembar waktu

Proyek

3

Proyek, tahapan, dan biaya yang melekat padanya.

proyekfase-proyekbiaya-proyek
proyek Proyek

Pemesanan

3

Janji temu, layanan yang dapat dipesan, dan staf yang menyediakannya.

pemesananlayanan pemesananpemesanan-staf
pemesanan Pemesanan

Layanan Lapangan

7

Pekerjaan, teknisi, perintah kerja, kontrak, dan peralatan.

pekerjaan-lapanganteknisiservice-requestskontrak-layananpesanan-kerjakartu-kerja+1 lainnya
layanan_lapangan Layanan Lapangan

Logistik.

5

Pengiriman, pengemudi, kendaraan, zona, dan kurir.

pengirimanPengemudiKendaraanzona-pengirimankurir
logistik Logistik.

Meja bantuan

5

Tiket, kebijakan SLA, artikel bantuan, dan basis pengetahuan.

tikettiket-pelangganartikel bantuanbasis-pengetahuanKebijakan SLA
Dukungan Meja bantuan

Pasca-Penjualan

5

Retur, klaim garansi, perbaikan, dan registrasi produk.

rmasklaim-garansipendaftaran garansiperbaikanregistrasi-produk
Purna jual Pasca-Penjualan

Sewa

3

Aset yang dapat disewakan, perjanjian sewa, dan rinciannya.

asetsewalini-sewa
sewa Sewa

Restoran

2

Menu dan pesanan yang dibuat berdasarkan menu tersebut.

item-menuPesanan menu
restoran F&B

Antrean

5

Tiket, layanan, konter, cabang, dan layar tampilan.

tiket antreanLayanan antreanpenghitung-antreanAntrean cabangtampilan-antrean
antrean Antrean

Loyalitas

6

Anggota, akun, tingkatan, hadiah, dan transaksi poin.

anggota-loyalitasAkun loyalitashadiah-loyalitastingkat-loyalitastransaksi-loyalitaskupon-loyalitas
loyalitas Loyalitas

Lokasi

2

Lokasi dan cabang.

lokasicabang
lokasi Lokasi

IOT

6

Perangkat, lokasi, kotak, peringatan, acara, dan konten papan nama.

perangkat IoTsitus-iotnotifikasi-iotiot-eventskotak iotiot-signage-content
iot Hub IOT

AI Studio

3

Aset yang dihasilkan, proyek yang menampungnya, dan riwayat pekerjaan.

aset-aiai-projectsai-jobs
ai_studio AI Studio

Perdagangan

3

Anggota jaringan, permintaan penawaran, dan penagihan.

anggota-jaringanpermintaan-penawarankoleksi
perdagangan Perdagangan

Tanda tangan elektronik

2

Permintaan tanda tangan dan tanda tangan yang dikumpulkan darinya.

Permintaan tanda tangantanda-tangan
tanda tangan e-Tanda Tangan

Persetujuan

2

Permintaan persetujuan dan aturan yang mengarahkannya.

approval-requestsaturan-persetujuan
Persetujuan Persetujuan

Berkas

2

Berkas yang diunggah dan dokumen yang dipindai.

filedokumen yang dipindai
file Berkas

Aktivitas

3

Umpan aktivitas, log audit, dan notifikasi.

aktivitaslog auditnotifikasi
Melalui telepon

Setiap modul yang dibaca API, tim Anda dapat membukanya di tangan mereka

Ini adalah bagian yang biasanya tidak benar. Banyak platform mengekspos API yang luas dan kemudian meluncurkan aplikasi seluler yang melakukan tiga hal — menyetujui, melihat, memberi tahu. Aplikasi Kardopal adalah produknya, bukan pendamping: semua 29 modul di atas memiliki layar nyata, dan ponsel adalah tempat sebagian besar pekerjaan benar-benar terjadi.

  • Baca, lalu bertindak. Integrasi Anda menarik tingkat stok; orang yang harus memperbaikinya membuka catatan yang sama, menyesuaikannya, dan itu ditandatangani atas nama mereka.
  • Pindai, foto, tanda tangani. Pemindaian barcode, pengambilan dokumen, dan tanda tangan elektronik adalah fitur asli ponsel — tidak ada padanan desktop yang layak digunakan.
  • Toleran luring di konter. Mesin kasir, layar dapur, dan tampilan antrean tetap berfungsi saat koneksi terganggu.
  • Satu login, satu data, 20 bahasa. Termasuk kanan-ke-kiri, sehingga tim berbahasa Arab tidak membaca tata letak yang terbalik.
Lihat platformnya.
Aplikasi Kardopal berjalan di ponsel

Mendapatkan kunci

Buka aplikasi, buka Platform → Kunci API.Kunci dibuat oleh pemilik atau admin di tenant Anda sendiri. Tidak ada seorang pun di Kardopal yang menerbitkannya untuk Anda.
Centang hanya modul yang dibutuhkan integrasi.Widget jendela toko membutuhkan item. Itu tidak membutuhkan hr. Kunci sempit gagal aman.
Kirim sebagai header, jangan pernah di URL.X-API-Key: kp_live_… — string kueri berakhir di log, proksi, dan riwayat peramban.
Rotasi dengan membuat kunci baru terlebih dahulu.Keduanya berfungsi sekaligus, sehingga Anda dapat memindahkan lalu lintas dan mencabut yang lama tanpa jeda waktu henti.

Bangun sesuatu di atasnya

API mendokumentasikan dirinya sendiri: buat kunci di aplikasi, arahkan curl di URL dasar, dan ia mengembalikan setiap modul, sumber daya, dan bidang yang dapat dicari yang dapat diakses oleh kunci tersebut.

Buat kunci API