API i dokumentacja

Jeden klucz. Każdy moduł.

Większość oprogramowania biznesowego oferuje API dla każdego produktu — jedno dla kasy, inne dla magazynu, trzecie dla faktur, każde z własnym uwierzytelnianiem i własną koncepcją daty. Kardopal ma jedno. Ten sam klucz, ten sam bazowy URL i ta sama gramatyka zapytań docierają do 129 zasobów w 29 modułach.

Utwórz klucz API Zobacz, co osiąga
29
Moduły
129
Zasoby
1
Klucz, jeden podstawowy URL
200
Wierszy na stronę, maks.

Dlaczego warto budować na tym API

Sześć rzeczy, które są tu prawdą, a zazwyczaj nie.

Opisuje się samo

Po wywołaniu bazowego adresu URL, API zwraca swój własny katalog — każdy moduł, który widzi Twój klucz, każdy zasób w nim, które pola są przeszukiwalne, a które filtrowalne. Nie potrzebujesz tej strony, aby napisać integrację; potrzebujesz jej, aby podjąć decyzję o jej napisaniu.

Uprawnienia, które rzeczywiście ograniczają dostęp

Zakresy, trasy i uprawnienia w aplikacji są generowane z jednej listy, więc uprawnienie nie może być oferowane, jeśli nie ma za nim punktu końcowego. Klucz o zakresie pozycje pobiera pozycje — zapytanie o listę płac zwraca błąd 403, a nie pustą stronę.

Jedna gramatyka zapytań, wszędzie

Wyszukiwanie, od, do, pomiń i weź oznaczają to samo na fakturach, co w ruchach magazynowych. Naucz się struktury raz, a każdy ze 133 zasobów będzie jej odpowiadał.

Twój tenant, i tylko Twój

Każda tabela zawiera identyfikator najemcy, a każde zapytanie jest ograniczone do własnego najemcy klucza, zanim dotrze do bazy danych. Nie ma możliwości błędnego odczytu między najemcami, ponieważ nie ma parametru, który mógłby o to poprosić.

Pola same dbają o poprawność

Lista pól jest odczytywana z aktywnego schematu przy uruchomieniu, a nie utrzymywana ręcznie. Nowa kolumna pojawia się automatycznie; usunięta nigdy nie pozostawi wiszącego odwołania w dokumentacji ani błędu 500 przy pierwszym wywołaniu.

Tylko do odczytu, celowo.

Klucze odczytują; nigdy nie zapisują. Błędna integracja nie może unieważnić faktury ani przesunąć zapasów. Wszystko, co zmienia rekord, przechodzi przez aplikację lub logowanie personelu, gdzie jest przypisane do osoby i trafia do dziennika audytu.

Rozpocznij jednym zapytaniem

Wszystko to GET. Jeśli możesz użyć curl, możesz tego użyć.

POBIERZ /api/v1Cały katalog dostępny dla Twojego klucza
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
POBIERZ /api/v1/meSonda bezpieczeństwa — czyj to klucz i co może odczytać
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
POBIERZ /api/v1/items?search=lamp&take=2Dowolny zasób, ten sam kształt
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
POBIERZ /api/v1/meta/countsLiczba wierszy na zasób — zobacz, jakie dane faktycznie istnieją
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Pięć parametrów

ParametrRobiNotatki
WyszukiwanieDopasowanie bez uwzględniania wielkości liter w przeszukiwalnych polach zasobuKtóre to pola, jest wymienione w /meta
odTylko rekordy od tej datyDotyczy pola, według którego zasób jest sortowany
doTylko zapisy do tej datyPołącz z od dla okna
pomińPrzesunięcie w zbiorze wynikówDomyślnie 0
weźIle wierszy zwrócićDomyślnie 50, maksymalnie 200

Zasoby akceptują również filtry dokładnego dopasowania dla swoich zadeklarowanych pól — ?status=opłacone, ?warehouseId=… — a każdy z nich reklamuje, które to są. Każda odpowiedź listy zawiera suma i maWięcej, więc stronicowanie to pętla, nie zgadywanie.

Co obejmuje API

29 modułów, 129 zasoby. Każda karta to jedno uprawnienie, które możesz nadać kluczowi — a szary tag wskazuje, gdzie te same rekordy znajdują się w aplikacji na Twoim telefonie.

Kontakty

2

Klienci, dostawcy i segmenty, do których należą.

kontaktysegmenty kontaktów
kontakty Kontakty

Pozycje

7

Katalog: produkty, warianty, marki, cenniki i jednostki.

pozycjekategoriemarkiwarianty-pozycjicennikijednostki+1 więcej
pozycje Pozycje

Magazyn

7

Magazyny, stany magazynowe, ruchy, partie, numery seryjne i lokalizacje.

magazynyruchy-magazynowestany magazynowepartieserialsInwentaryzacje+1 więcej
inwentarz Magazyn

Sprzedaż

7

Faktury, wyceny, zamówienia, noty kredytowe i płatności.

fakturykosztorysyzamówienia sprzedażykorekty fakturpłatnościfaktury-cykliczne+1 więcej
sprzedaż Sprzedaż

POS

11

Kasy, zmiany, paragony, stoły i każda sprzedaż, która przeszła przez ladę.

sprzedaż POSzmiany-posterminale-posużytkownicy POSstoły POSobszary-stołów-pos+5 więcej
pos POS

CRM

4

Leady, transakcje, lejki sprzedażowe i oferty.

leadydealsprocesy sprzedażypropozycje
crm CRM

Zakup

5

Zamówienia zakupu, zapytania, zwroty, rachunki i płatności dla dostawców.

zamówienia-zakupuzapytania-zakupoweZwroty zakupówrachunkiPłatności dla dostawców
zakup Zakup

Księgowość

5

Koszty, konta bankowe, transakcje i stawki podatkowe.

wydatkikategorie-wydatkówkonta-bankowetransakcje bankowetax-rates
księgowość Księgowość

Marketing

4

Kampanie, odbiorcy, strony docelowe i zgłoszenia formularzy.

kampanieodbiorcy-kampaniistrony doceloweprzesłane formularze
marketing Marketing

HR

8

Ludzie, działy, urlopy, paski płac, obecność i rekrutacja.

pracownicydziaływnioski o urloppaski płacobecnośćoferty-pracy+2 więcej
hr HR

Karta czasu pracy

2

Wpisy czasu pracy i projekty, do których są przypisane.

wpisy-czasuprojekty-ewidencja-czasu
karta czasu pracy Karta czasu pracy

Projekty

3

Projekty, etapy i związane z nimi koszty.

projektyfazy-projektukoszty-projektu
projekty Projekty

Rezerwacja

3

Spotkania, usługi do rezerwacji i personel, który je świadczy.

rezerwacjeusługi-rezerwacjirezerwacja-personelu
rezerwacje Rezerwacja

Serwis terenowy

7

Zadania, technicy, zlecenia pracy, umowy i sprzęt.

field-jobstechnicyservice-requestsumowy serwisowezlecenia pracykarty-pracy+1 więcej
serwis terenowy Serwis terenowy

Logistyka.

5

Przesyłki, kierowcy, pojazdy, strefy i przewoźnicy.

wysyłkikierowcypojazdystrefy-dostawprzewoźnicy
logistyka Logistyka.

Helpdesk

5

Zgłoszenia, polityki SLA, artykuły pomocy i baza wiedzy.

zgłoszeniazgłoszenia klientówartykuły-pomocybaza-wiedzypolityka-sla
wsparcie Helpdesk

Obsługa posprzedażowa

5

Zwroty, roszczenia gwarancyjne, naprawy i rejestracje produktów.

rmasroszczenia gwarancyjnerejestracje-gwarancjinaprawyrejestracje-produktów
po_sprzedaży Obsługa posprzedażowa

Wynajem

3

Aktywa do wynajęcia, umowy najmu i ich pozycje.

aktywawynajemlinie wynajmu
wynajem Wynajem

Restauracja

2

Menu i złożone na jego podstawie zamówienia.

menu-itemszamówienia-menu
restauracja Gastronomia

Kolejka

5

Zgłoszenia, usługi, liczniki, oddziały i ekrany wyświetlające.

bilety-kolejkoweusługi-kolejkoweliczniki-kolejekkolejki-oddziaływyświetlacze-kolejkowe
kolejka Kolejka

Lojalność

6

Członkowie, konta, poziomy, nagrody i transakcje punktowe.

członkowie programu lojalnościowegokonta-lojalnościowenagrody-lojalnościowepoziomy lojalnościowetransakcje-lojalnościowekupony lojalnościowe
lojalność Lojalność

Lokalizacje

2

Oddziały i placówki.

lokalizacjeoddziały
lokalizacje Lokalizacje

IOT

6

Urządzenia, lokalizacje, skrzynki, alerty, zdarzenia i treści oznakowania.

iot-devicesmiejsca IoTalerty IoTiot-eventsiot-boxestreści-iot-signage
iot Hub IOT

AI Studio

3

Wygenerowane zasoby, projekty, które je zawierają, oraz historia zadań.

ai-assetsai-projectsai-jobs
ai_studio AI Studio

Handel

3

Członkowie sieci, zapytania ofertowe i windykacja.

członkowie siecizapytania-ofertoweKolekcje
handel Handel

e-Podpis

2

Żądania podpisów i zebrane podpisy.

żądania-podpisupodpisy
podpis e-Podpis

Zatwierdzenia

2

Wnioski o zatwierdzenie i zasady ich przekierowywania.

wnioski-o-zatwierdzeniezasady-zatwierdzania
zatwierdzenia Zatwierdzenia

Pliki

2

Przesłane pliki i zeskanowane dokumenty.

plikizeskanowane-dokumenty
pliki Pliki

Aktywność

3

Kanał aktywności, dziennik audytu i powiadomienia.

aktywnościlogi audytupowiadomienia
Przez telefon

Każdy moduł, który odczytuje API, Twój zespół może otworzyć w dłoni

To jest część, która zazwyczaj nie jest prawdą. Wiele platform udostępnia szerokie API, a następnie dostarcza aplikację mobilną, która robi trzy rzeczy — zatwierdza, wyświetla, powiadamia. Aplikacja Kardopal to produkt, a nie dodatek: wszystkie 29 modułów powyżej ma prawdziwe ekrany, a telefon to miejsce, gdzie faktycznie odbywa się większość pracy.

  • Przeczytaj, a następnie działaj. Twoja integracja pobiera poziom zapasów; osoba, która musi to naprawić, otwiera ten sam rekord, dostosowuje go i podpisuje swoim nazwiskiem.
  • Skanuj, fotografuj, podpisuj. Skanowanie kodów kreskowych, przechwytywanie dokumentów i e-podpis są natywne dla telefonu — nie mają godnego uwagi odpowiednika na komputerze stacjonarnym.
  • Odporność na brak połączenia przy kasie. Kasa, ekran kuchenny i wyświetlacz kolejki działają, gdy połączenie jest niestabilne.
  • Ten sam login, te same dane, 20 języków. W tym obsługa od prawej do lewej, dzięki czemu zespół arabskojęzyczny nie czyta lustrzanego układu.
Zobacz platformę.
Aplikacja Kardopal działająca na telefonie

Uzyskiwanie klucza

Otwórz aplikację, przejdź do Platforma → Klucze API.Klucze są tworzone przez właściciela lub administratora w Twojej własnej instancji. Nikt w Kardopal nie wydaje ich za Ciebie.
Zaznacz tylko moduły, których wymaga integracja.Widżet witryny sklepu potrzebuje pozycje. Nie potrzebuje hr. Wąskie klucze są bezpieczne.
Wyślij jako nagłówek, nigdy w adresie URL.X-API-Key: kp_live_… — ciągi zapytań trafiają do logów, serwerów proxy i historii przeglądarki.
Zmień, tworząc najpierw nowy klucz.Oba działają jednocześnie, więc możesz przenosić ruch i unieważnić stary bez przestojów.

Zbuduj coś na tym

API dokumentuje się samo: utwórz klucz w aplikacji, wskaż curl pod bazowym adresem URL, a zwraca każdy moduł, zasób i pole wyszukiwania, do którego klucz ma dostęp.

Utwórz klucz API