API & dokumen

Satu kunci. Setiap modul.

Kebanyakan perisian perniagaan memberi anda satu API bagi setiap produk — satu untuk daftar tunai, satu lagi untuk stok, yang ketiga untuk invois, setiap satu dengan pengesahan dan konsep tarikhnya sendiri. Kardopal mempunyai satu. Kunci yang sama, URL asas yang sama dan tatabahasa pertanyaan yang sama mencapai 129 sumber merentasi 29 modul.

Cipta kunci API Lihat apa yang dicapai
29
Modul
129
Sumber
1
Kunci, satu URL asas
200
Baris setiap halaman, maks

Mengapa API ini berbaloi untuk dibangunkan

Enam perkara yang benar di sini dan biasanya tidak.

Ia menerangkan dirinya sendiri

Capai URL asas dan API akan mengembalikan katalognya sendiri — setiap modul yang boleh dilihat oleh kunci anda, setiap sumber di dalamnya, medan mana yang boleh dicari dan mana yang boleh ditapis. Anda tidak memerlukan halaman ini untuk menulis integrasi; anda memerlukannya untuk membuat keputusan.

Kebenaran yang benar-benar mengehadkan

Skop, laluan dan 'permission pills' dalam aplikasi dijana daripada satu senarai, jadi kebenaran tidak boleh ditawarkan melainkan ada titik akhir di belakangnya. Kunci yang diskopkan kepada item mendapatkan item — memintanya untuk gaji mengembalikan 403, bukan halaman kosong senyap.

Satu tatabahasa pertanyaan, di mana-mana

cari, sejak, sehingga, langkau dan ambil bermaksud perkara yang sama pada invois seperti pada pergerakan stok. Fahami bentuknya sekali dan setiap satu daripada 133 sumber akan mematuhinya.

Penyewa anda, dan hanya milik anda

Setiap jadual membawa ID penyewa dan setiap pertanyaan disasarkan kepada penyewa kunci itu sendiri sebelum ia mencapai pangkalan data. Tiada bacaan silang penyewa yang boleh tersilap, kerana tiada parameter yang boleh memintanya.

Medan memastikan ketepatan data

Senarai medan dibaca daripada skema langsung semasa but dan bukannya diselenggara secara manual. Lajur baharu muncul dengan sendirinya; lajur yang digugurkan tidak akan meninggalkan rujukan tergantung dalam dokumen atau ralat 500 pada panggilan pertama.

Baca sahaja, dengan sengaja

Kunci membaca; ia tidak pernah menulis. Integrasi yang salah tidak boleh membatalkan invois atau memindahkan stok. Apa-apa yang mengubah rekod melalui aplikasi atau log masuk kakitangan, di mana ia dikaitkan dengan seseorang dan mendarat dalam log audit.

Mula dalam satu permintaan

Semuanya adalah GET. Jika anda boleh menggunakan curl, anda boleh gunakan ini.

GET /api/v1Seluruh katalog yang boleh dilihat oleh 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 boleh dibacanya
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Mana-mana sumber, 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/countsKiraan baris setiap sumber — lihat data apa yang sebenarnya wujud
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Lima parameter

ParameterFungsiNota
cariPadanan tidak sensitif huruf besar-kecil merentasi medan yang boleh dicari sumberMedan-medan tersebut disenaraikan dalam /meta
sejakHanya rekod dari tarikh ini ke hadapanBerlaku pada medan yang diisih oleh sumber
sehinggaHanya rekod sehingga tarikh iniGabungkan dengan sejak untuk tetingkap
langkauOfset ke dalam set hasilLalai kepada 0
ambilBerapa banyak baris untuk dikembalikanLalai kepada 50, dihadkan kepada 200

Sumber juga menerima penapis padanan tepat pada medan yang diisytiharkan sendiri — ?status=paid, ?warehouseId=… — dan setiap satunya mengiklankan yang mana. Setiap respons senarai membawa jumlah dan adaLagi, jadi penomboran halaman adalah gelung, bukan tekaan.

Apa yang dicapai oleh API

29 modul, 129 sumber. Setiap kad adalah satu kebenaran yang boleh anda berikan kepada kunci — dan tag kelabu adalah tempat rekod yang sama berada dalam aplikasi pada telefon anda.

Kenalan

2

Pelanggan, pembekal dan segmen mereka.

kenalansegmen-hubungan
kenalan Kenalan

Item

7

Katalog: produk, varian, jenama, senarai harga dan unit.

itemkategorijenamavarian-itemsenarai hargaunit+1 lagi
item Item

Inventori

7

Gudang, paras stok, pergerakan, kelompok, siri dan tong.

gudangpergerakan-stoktahap stokkelompoksirikiraan-stok+1 lagi
inventori Inventori

Jualan

7

Invois, anggaran, pesanan, nota kredit dan pembayaran.

invoisanggaranpesanan-jualannota-kreditpembayaraninvois-berulang+1 lagi
jualan Jualan

POS

11

Daftar tunai, syif, resit, meja dan setiap jualan yang berlaku di kaunter.

jualan POSpos-shiftsterminal-pospengguna-posmeja-poskawasan-meja-pos+5 lagi
pos POS

CRM

4

Prospek, urus niaga, saluran paip dan cadangan.

petunjuktawaranSaluran kerjacadangan
crm CRM

Pembelian

5

Pesanan pembelian, permintaan, pemulangan, bil dan pembayaran vendor.

pesanan-pembelianpurchase-requestspulangan pembelianbilpembayaran-vendor
pembelian Pembelian

Perakaunan

5

Perbelanjaan, akaun bank, transaksi dan kadar cukai.

perbelanjaanexpense-categoriesakaun-bankbank-transactionskadar-cukai
Perakaunan Perakaunan

Pemasaran

4

Kempen, penerima, halaman pendaratan dan penghantaran borang.

kempencampaign-recipientshalaman-pendaratanPenyerahan borang
pemasaran Pemasaran

HR

8

Kakitangan, jabatan, cuti, slip gaji, kehadiran dan pengambilan pekerja.

Pekerjajabatanleave-requestsslip gajiKehadiranjob-postings+2 lagi
hr HR

Lembaran masa

2

Catatan masa dan projek yang ditempah.

time-entriesprojek lembaran masa
lembaran masa Lembaran masa

Projek

3

Projek, fasa dan kos yang berkaitan dengannya.

projekfasa-projekkos-projek
projek Projek

Tempahan

3

Temujanji, perkhidmatan yang boleh ditempah dan kakitangan yang menyediakannya.

tempahanperkhidmatan tempahantempahan kakitangan
tempahan Tempahan

Perkhidmatan Lapangan

7

Kerja, juruteknik, pesanan kerja, kontrak dan peralatan.

kerja-lapanganjuruteknikpermintaan-perkhidmatankontrak perkhidmatanpesanan kerjakad-kerja+1 lagi
perkhidmatan lapangan Perkhidmatan Lapangan

Logistik.

5

Penghantaran, pemandu, kenderaan, zon dan pengangkut.

penghantaranpemandukenderaanzon-penghantaranpengangkut
logistik Logistik.

Meja Bantuan

5

Tiket, polisi SLA, artikel bantuan dan pangkalan pengetahuan.

tikettiket pelangganartikel bantuanpangkalan-pengetahuansla-policies
sokongan Meja Bantuan

Selepas Jualan

5

Pulangan, tuntutan waranti, pembaikan dan pendaftaran produk.

RMAtuntutan warantipendaftaran warantipembaikanpendaftaran-produk
pasca-jualan Selepas Jualan

Sewaan

3

Aset boleh sewa, perjanjian sewa dan butirannya.

asetsewaanbarisan sewaan
sewaan Sewaan

Restoran

2

Menu dan pesanan yang dibuat melaluinya.

item-menupesanan-menu
restoran F&B

Barisan

5

Tiket, perkhidmatan, kaunter, cawangan dan skrin paparan.

tiket giliranperkhidmatan-giliranqueue-counterscawangan-giliranpaparan-giliran
barisan Barisan

Kesetiaan

6

Ahli, akaun, peringkat, ganjaran dan transaksi mata.

loyalty-membersakaun-kesetiaanganjaran-kesetiaanperingkat-kesetiaantransaksi-kesetiaanloyalty-coupons
kesetiaan Kesetiaan

Lokasi

2

Tapak dan cawangan.

lokasicawangan
lokasi Lokasi

IOT

6

Peranti, tapak, kotak, amaran, acara dan kandungan papan tanda.

peranti-iotiot-sitesamaran-iotiot-eventskotak iotiot-signage-content
iot Hab IOT

Studio AI

3

Aset yang dijana, projek yang memegangnya dan sejarah kerja.

aset-aiprojek-aiai-jobs
ai_studio Studio AI

Perdagangan

3

Ahli rangkaian, permintaan sebut harga dan kutipan.

ahli-rangkaianquote-requestskoleksi
Perdagangan Perdagangan

e-Tandatangan

2

Permintaan tandatangan dan tandatangan yang dikumpul terhadapnya.

permintaan-tandatangantandatangan
tandatangan e-Tandatangan

Kelulusan

2

Permintaan kelulusan dan peraturan yang mengarahkannya.

approval-requestsperaturan-kelulusan
kelulusan Kelulusan

Fail

2

Fail yang dimuat naik dan dokumen yang diimbas.

faildokumen diimbas
fail Fail

Aktiviti

3

Suapan aktiviti, log audit dan pemberitahuan.

aktivitilog auditpemberitahuan
Melalui telefon

Setiap modul yang dibaca oleh API, pasukan anda boleh buka di tangan mereka.

Ini adalah bahagian yang selalunya tidak benar. Banyak platform mendedahkan API yang luas dan kemudian menghantar aplikasi mudah alih yang melakukan tiga perkara — meluluskan, melihat, memberitahu. Aplikasi Kardopal adalah produk itu sendiri, bukan sekadar teman: kesemua 29 modul di atas mempunyai skrin sebenar, dan telefon adalah tempat kebanyakan kerja sebenarnya berlaku.

  • Baca, kemudian bertindak. Integrasi anda menarik paras stok; orang yang perlu membetulkannya membuka rekod yang sama, melaraskannya dan ia ditandatangani atas nama mereka.
  • Imbas, tangkap, tandatangan. Pengimbasan kod bar, penangkapan dokumen dan e-tandatangan adalah asli telefon — tiada setara desktop yang berbaloi untuk digunakan.
  • Tahan luar talian di kaunter. Daftar tunai, skrin dapur dan paparan giliran terus berfungsi apabila sambungan terganggu.
  • Log masuk yang sama, data yang sama, 20 bahasa. Termasuk dari kanan ke kiri, jadi pasukan berbahasa Arab tidak membaca susun atur yang terbalik.
Lihat platform.
Aplikasi Kardopal yang berjalan pada telefon

Mendapatkan kunci

Buka aplikasi, pergi ke Platform → Kunci API.Kunci dicipta oleh pemilik atau pentadbir pada penyewa anda sendiri. Tiada sesiapa di Kardopal yang mengeluarkannya untuk anda.
Tandakan hanya modul yang diperlukan oleh integrasi.Widget tingkap kedai memerlukan item. Ia tidak memerlukan hr. Kunci sempit gagal selamat.
Hantar sebagai pengepala, jangan sekali-kali dalam URL.X-API-Key: kp_live_… — rentetan pertanyaan berakhir dalam log, proksi dan sejarah pelayar.
Putar dengan mencipta kunci baharu terlebih dahulu.Kedua-duanya berfungsi serentak, jadi anda boleh memindahkan trafik dan membatalkan yang lama tanpa tempoh henti.

Bina sesuatu di atasnya

API mendokumentasikan dirinya sendiri: cipta kunci dalam aplikasi, halakan curl pada URL asas, dan ia mengembalikan setiap modul, sumber dan medan yang boleh dicari yang boleh dicapai oleh kunci tersebut.

Cipta kunci API