API 및 문서

하나의 키. 모든 모듈.

대부분의 비즈니스 소프트웨어는 제품별 API를 제공합니다. 계산대용, 재고용, 송장용 API가 각각 따로 있고, 인증 방식과 날짜 처리 방식도 제각각입니다. Kardopal은 단 하나의 API를 제공합니다. 동일한 키, 동일한 기본 URL, 동일한 쿼리 문법으로 29개 모듈의 129개 리소스에 접근할 수 있습니다.

29
모듈
129
자료
1
키, 하나의 기본 URL
200
페이지당 최대 행 수

이 API를 기반으로 구축할 가치가 있는 이유

여기서는 사실이지만 보통은 그렇지 않은 여섯 가지.

스스로 설명합니다

기본 URL에 접속하면 API가 자체 카탈로그를 반환합니다. 귀하의 키가 볼 수 있는 모든 모듈, 그 안에 있는 모든 리소스, 검색 가능한 필드와 필터링 가능한 필드를 보여줍니다. 통합을 작성하기 위해 이 페이지가 필요한 것이 아니라, 통합을 결정하기 위해 필요합니다.

실질적인 접근 권한

앱의 범위, 경로 및 권한 필은 하나의 목록에서 생성되므로, 백엔드에 엔드포인트가 없으면 권한을 제공할 수 없습니다. 다음으로 범위가 지정된 키: 품목 항목을 가져옵니다 — 급여를 요청하면 조용한 빈 페이지가 아닌 403을 반환합니다.

어디서나 통용되는 하나의 쿼리 문법

검색, 이후, 까지, 건너뛰기 및 take 재고 이동과 마찬가지로 인보이스에서도 동일한 의미를 가집니다. 한 번만 익히면 133개의 모든 리소스에 적용됩니다.

귀하의 테넌트, 오직 귀하만을 위한

모든 테이블은 테넌트 ID를 가지며, 모든 쿼리는 데이터베이스에 도달하기 전에 키 자체의 테넌트에 한정됩니다. 교차 테넌트 읽기는 잘못될 수 없는데, 이를 요청할 수 있는 매개변수가 없기 때문입니다.

필드 데이터의 무결성 유지

필드 목록은 수동으로 관리하는 대신 부팅 시 라이브 스키마에서 읽어옵니다. 새 열은 자동으로 나타나고, 삭제된 열은 문서에 매달린 참조를 남기거나 첫 호출에서 500 오류를 발생시키지 않습니다.

의도적인 읽기 전용.

키는 읽기 전용입니다. 쓰기 작업은 하지 않습니다. 잘못된 통합은 송장을 무효화하거나 재고를 이동시킬 수 없습니다. 기록을 변경하는 모든 작업은 앱 또는 직원 로그인을 통해 이루어지며, 이는 특정인에게 귀속되고 감사 로그에 기록됩니다.

한 번의 요청으로 시작

모든 것이 GET 요청입니다. 만약 다음을 사용할 수 있다면 curl, 이를 사용할 수 있습니다.

시작하기 /api/v1귀하의 키로 볼 수 있는 전체 카탈로그
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
시작하기 /api/v1/me유효성 검사 — 이 키는 누구의 것이며, 어떤 정보를 읽을 수 있습니까?
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
시작하기 /api/v1/items?search=lamp&take=2모든 리소스, 동일한 형태
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
시작하기 /api/v1/meta/counts리소스별 행 수 — 어떤 데이터가 실제로 존재하는지 확인
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

다섯 가지 매개변수

매개변수기능메모
검색리소스의 검색 가능한 필드 전체에서 대소문자 구분 없는 일치.해당 필드는 다음에서 나열됩니다. /메타
이후이 날짜 이후의 기록만리소스가 정렬하는 필드에 적용됩니다.
까지이 날짜까지의 기록만결합 이후 창을 위한
건너뛰기결과 세트 내 오프셋.기본값 0
take반환할 행 수기본값 50, 최대 200

리소스는 자체 선언된 필드에 대해 정확히 일치하는 필터도 허용합니다 — ?status=paid, ?warehouseId=… — 그리고 각 응답은 어떤 것인지 알려줍니다. 모든 목록 응답에는 다음이 포함됩니다. 총계 및 더 보기, 따라서 페이징은 추측이 아닌 반복입니다.

API가 접근하는 범위

29개 모듈, 129개 리소스. 각 카드는 키에 부여할 수 있는 하나의 권한이며, 회색 태그는 휴대폰 앱에 동일한 기록이 있는 곳입니다.

연락처

2

고객, 공급업체, 그리고 그들이 속한 세그먼트.

연락처연락처 세그먼트
연락처 연락처

품목

7

카탈로그: 제품, 품목, 브랜드, 가격표 및 단위.

품목카테고리브랜드품목 변형가격표단위+1개 더
품목 품목

재고

7

창고, 재고 수준, 이동, 배치, 일련번호 및 보관함.

창고재고 이동재고 현황배치일련 번호재고 집계+1개 더
재고 재고

영업

7

송장, 견적, 주문, 신용 메모 및 결제.

송장견적판매 주문신용 전표결제반복 송장+1개 더
영업 영업

POS

11

계산대, 교대 근무, 영수증, 테이블, 그리고 계산대를 거쳐간 모든 판매.

POS 판매POS 교대 근무POS 단말기POS 사용자POS 테이블POS 테이블 구역+5개 더
pos POS

CRM

4

리드, 거래, 파이프라인 및 제안.

잠재 고객딜파이프라인제안서
crm CRM

구매

5

구매 주문, 요청, 반품, 청구서 및 공급업체 결제.

구매 주문구매 요청구매 반품청구서공급업체 결제
구매 구매

회계

5

경비, 은행 계좌, 거래 및 세율.

경비비용 카테고리은행 계좌bank-transactions세율
회계 회계

마케팅

4

캠페인, 수신자, 랜딩 페이지 및 양식 제출.

캠페인캠페인 수신자랜딩 페이지양식 제출
마케팅 마케팅

HR

8

인사, 부서, 휴가, 급여 명세서, 근태 및 채용.

직원부서leave-requests급여 명세서근태채용 공고+2개 더
hr HR

근무 시간 기록표

2

시간 기록 및 해당 프로젝트.

시간 기록근무 시간표 프로젝트
근무 시간표 근무 시간 기록표

프로젝트

3

프로젝트, 단계 및 관련 비용.

프로젝트프로젝트 단계프로젝트 비용
프로젝트 프로젝트

예약

3

예약, 예약 가능한 서비스 및 서비스를 제공하는 직원.

예약예약 서비스예약 직원
예약 예약

현장 서비스

7

작업, 기술자, 작업 지시, 계약 및 장비.

현장 작업기술자서비스 요청서비스 계약work-orders작업 카드+1개 더
현장 서비스 현장 서비스

물류.

5

배송, 운전자, 차량, 구역 및 운송업체.

배송드라이버차량배송 구역운송업체
물류 물류.

헬프데스크

5

티켓, SLA 정책, 도움말 문서 및 지식 기반.

티켓고객 티켓도움말 문서지식 기반SLA 정책
지원 헬프데스크

사후 판매

5

반품, 보증 청구, 수리 및 제품 등록.

RMAwarranty-claims보증 등록수리제품 등록
사후 판매 사후 판매

렌탈

3

임대 가능한 자산, 임대 계약 및 그 세부 내역.

자산대여렌탈 라인
렌탈 렌탈

레스토랑

2

메뉴와 그에 따라 접수된 주문.

메뉴 항목메뉴 주문
레스토랑 F&B

대기열

5

티켓, 서비스, 카운터, 지점, 그리고 디스플레이 화면.

대기표대기열 서비스대기열 카운터대기열 지점대기열 디스플레이
대기열 대기열

로열티

6

회원, 계정, 등급, 보상 및 포인트 거래.

loyalty-members로열티 계정로열티 보상로열티 등급로열티 거래loyalty-coupons
로열티 로열티

위치

2

사이트 및 지점.

지점지점
지점 위치

IOT

6

기기, 사이트, 박스, 알림, 이벤트 및 간판 콘텐츠.

IoT 장치iot-sitesIoT 알림IoT 이벤트IoT 박스IoT 사이니지 콘텐츠
iot IOT 허브

AI 스튜디오

3

생성된 자산, 관련 프로젝트, 작업 이력.

AI 자산AI 프로젝트ai-jobs
ai_studio AI 스튜디오

커머스

3

네트워크 회원, 견적 요청 및 수금.

네트워크 회원견적 요청컬렉션
커머스 커머스

전자 서명

2

서명 요청 및 이에 따라 수집된 서명

서명 요청서명
서명 전자 서명

승인

2

승인 요청 및 라우팅 규칙.

승인 요청승인 규칙
승인 승인

파일

2

업로드된 파일 및 스캔된 문서.

파일스캔 문서
파일 파일

활동

3

활동 피드, 감사 로그 및 알림.

활동감사 로그알림
전화로

API가 읽는 모든 모듈을 팀원들이 손 안에서 열어볼 수 있습니다.

이것은 일반적으로 사실이 아닌 부분입니다. 많은 플랫폼이 광범위한 API를 공개하고 승인, 보기, 알림 세 가지 기능만 수행하는 모바일 앱을 제공합니다. Kardopal의 앱은 보조 도구가 아닌 제품 그 자체입니다. 위에 언급된 29개 모듈 모두 실제 화면을 가지고 있으며, 대부분의 작업이 휴대폰에서 실제로 이루어집니다.

  • 읽고 즉시 조치합니다. 통합 시스템이 재고 수준을 가져오면, 담당자가 해당 기록을 열어 조정하고 본인 이름으로 서명합니다.
  • 스캔, 촬영, 서명. 바코드 스캔, 문서 캡처, 전자 서명은 휴대폰에 최적화되어 있으며, 데스크톱에서는 사용할 만한 동등한 기능이 없습니다.
  • 계산대에서 오프라인 허용. 연결이 불안정해도 계산대, 주방 화면, 대기열 디스플레이는 계속 작동합니다.
  • 동일한 로그인, 동일한 데이터, 20개 언어. 아랍어 사용 팀이 미러링된 레이아웃을 읽지 않도록 오른쪽에서 왼쪽으로 쓰는 언어도 포함됩니다.
플랫폼 보기.
휴대폰에서 실행되는 Kardopal 앱

키 발급

앱을 열고, 플랫폼 → API 키로 이동합니다.키는 귀하의 테넌트에서 소유자 또는 관리자가 생성합니다. Kardopal에서는 키를 발급하지 않습니다.
통합에 필요한 모듈만 선택하십시오.매장 진열 위젯에는 다음이 필요합니다. 품목. 필요하지 않습니다. hr. 좁은 키는 안전하게 실패합니다.
URL이 아닌 헤더로 전송하십시오.X-API-Key: kp_live_… — 쿼리 문자열은 로그, 프록시 및 브라우저 기록에 남습니다.
새 키를 먼저 생성하여 교체하십시오.둘 다 동시에 작동하므로 트래픽을 이동하고 이전 버전을 중단 시간 없이 해지할 수 있습니다.

그 위에 무언가를 구축하세요.

API는 자체적으로 문서화됩니다: 앱에서 키를 생성하고, 가리킵니다. curl 기본 URL에서, 해당 키가 접근할 수 있는 모든 모듈, 리소스 및 검색 가능한 필드를 반환합니다.

API 키 생성