APIとドキュメント

一つのキー。すべてのモジュール。

ほとんどのビジネスソフトウェアは、製品ごとにAPIを提供します。レジ用、在庫用、請求書用とそれぞれに認証や日付の概念が異なります。Kardopalは1つです。同じキー、同じベースURL、同じクエリ文法で、29のモジュールにわたる129のリソースにアクセスできます。

29
モジュール
129
リソース
1
キー、単一のベースURL
200
1ページあたりの最大行数

このAPIを基盤とする価値

ここで真実となる、通常とは異なる6つのこと。

自己記述型

ベースURLにアクセスすると、APIは自身のカタログを返します。キーでアクセスできるすべてのモジュール、その内部のすべてのリソース、検索可能なフィールドとフィルタリング可能なフィールド。このページは連携を記述するために必要なのではなく、連携を決定するために必要です。

権限によるアクセス制限

アプリ内のスコープ、ルート、権限ピルは一つのリストから生成されるため、エンドポイントがなければ権限は提供されません。キーのスコープは アイテム アイテムを取得します — 給与計算を要求すると、静かな空のページではなく403エラーが返されます。

どこでも使える単一のクエリ文法

検索, 以来, まで, スキップ と 取得 請求書上でも在庫移動上でも同じ意味を持つ。一度形を覚えれば、133のリソースすべてがそれに従う。

あなた専用のテナント

すべてのテーブルはテナントIDを持ち、すべてのクエリはデータベースに到達する前に、キー自身のテナントにスコープされます。そのような要求をするパラメータが存在しないため、誤ったテナント間読み取りは発生しません。

フィールドは整合性を保ちます

フィールドリストは手動で管理するのではなく、起動時にライブスキーマから読み取られます。新しい列は自動的に表示され、削除された列がドキュメントに宙ぶらりんの参照を残したり、初回呼び出しで500エラーを発生させたりすることはありません。

意図的に読み取り専用。

キーは読み取り専用で、書き込みはしません。統合に問題が発生しても、請求書が無効になったり、在庫が移動したりすることはありません。記録を変更する操作はすべてアプリまたはスタッフログインを介して行われ、担当者に帰属され、監査ログに記録されます。

一つのリクエストで開始

すべてがGETです。もし利用できるなら curl、これを使用できます。

GET /api/v1キーで閲覧できる全カタログ
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/me権限確認 — このキーは誰のもので、何にアクセスできるか
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /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" } ]
}
GET /api/v1/meta/countsリソースごとの行数 — 実際に存在するデータを確認できます。
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

5つのパラメータ

パラメータ実行メモ
検索リソースの検索可能フィールド全体で大文字と小文字を区別しない一致どのフィールドであるかは以下に記載されています /メタ
以来この日付以降の記録のみリソースがソートするフィールドに適用されます
までこの日付までの記録のみと組み合わせる 以来 期間
スキップ結果セットへのオフセットデフォルトは0
取得何行を返すかデフォルトは50、上限は200

リソースは、自身が宣言するフィールドに対する完全一致フィルターも受け付けます ?status=paid, ?warehouseId=… — そしてそれぞれがそれらが何であるかを宣伝します。すべてのリスト応答には 合計 と さらに表示、そのため、ページングは推測ではなくループです。

APIがアクセスできる範囲

29のモジュール、129のリソース。各カードはキーに付与できる1つの権限であり、灰色のタグはスマートフォンのアプリで同じレコードが存在する場所を示します。

連絡先

2

顧客、サプライヤー、そしてそれらが属するセグメント。

連絡先連絡先セグメント
連絡先 連絡先

商品

7

カタログ:製品、バリエーション、ブランド、価格表、単位。

アイテムカテゴリブランド商品バリアント価格表単位+1件
アイテム 商品

在庫管理

7

倉庫、在庫レベル、移動、ロット、シリアル、棚。

倉庫在庫移動在庫レベルバッチserials棚卸し+1件
在庫 在庫管理

売上

7

請求書、見積書、注文書、クレジットノート、支払い。

請求書見積もり販売注文クレジットノート支払い定期請求書+1件
営業 売上

POS

11

レジ、シフト、レシート、テーブル、そしてカウンターを越えたすべての販売。

POS売上POSシフトPOS端末POSユーザーPOSテーブルPOSテーブルエリアその他5件
pos POS

CRM

4

リード、商談、パイプライン、提案。

リードdealsパイプライン提案書
crm CRM

購入

5

発注書、依頼、返品、請求書、仕入先への支払い。

発注書購買依頼仕入返品請求書仕入先への支払い
購入 購入

会計

5

経費、銀行口座、取引、税率。

経費経費カテゴリ銀行口座bank-transactions税率
会計 会計

マーケティング

4

キャンペーン、受信者、ランディングページ、フォーム送信。

キャンペーンキャンペーン受信者ランディングページフォーム送信
マーケティング マーケティング

HR

8

人事、部署、休暇、給与明細、勤怠、採用。

従業員部門leave-requests給与明細出席求人情報+2件その他
hr HR

勤怠表

2

タイムエントリーと、それらが計上されるプロジェクト。

時間記録タイムシートプロジェクト
タイムシート 勤怠表

プロジェクト

3

プロジェクト、フェーズ、およびそれらに付随する費用。

プロジェクトプロジェクトフェーズプロジェクト費用
プロジェクト プロジェクト

予約

3

予約、予約可能なサービス、およびそれらを提供するスタッフ。

予約予約サービススタッフ予約
予約 予約

フィールドサービス

7

ジョブ、技術者、作業指示、契約、設備。

現場作業技術者service-requestsサービス契約作業指示書ジョブカード+1件
フィールドサービス フィールドサービス

ロジスティクス

5

出荷、ドライバー、車両、ゾーン、運送業者。

出荷ドライバー車両配送エリア運送業者
ロジスティクス ロジスティクス

ヘルプデスク

5

チケット、SLAポリシー、ヘルプ記事、ナレッジベース。

チケット顧客チケットヘルプ記事ナレッジベースSLAポリシー
サポート ヘルプデスク

アフターセールス

5

返品、保証請求、修理、製品登録。

RMA保証請求保証登録修理製品登録
アフターセールス アフターセールス

レンタル

3

貸出可能な資産、レンタル契約、およびその明細。

資産レンタルレンタルライン
レンタル レンタル

レストラン

2

メニューとそれに対する注文。

メニュー項目メニュー注文
レストラン 飲食

キュー

5

チケット、サービス、カウンター、支店、およびディスプレイ画面。

整理券順番待ちサービスキューカウンターキューブランチ順番待ち表示
キュー キュー

ロイヤルティ

6

会員、アカウント、ティア、特典、ポイント取引。

loyalty-membersポイント・会員管理ロイヤリティ特典ロイヤルティティアロイヤリティ取引loyalty-coupons
ロイヤルティ ロイヤルティ

ロケーション

2

サイトと支店。

拠点支店
拠点 ロケーション

IOT

6

デバイス、サイト、ボックス、アラート、イベント、サイネージコンテンツ。

iot-devicesiot-sitesIoTアラートiot-eventsIoTボックスIoTサイネージコンテンツ
iot IOTハブ

AI Studio

3

生成されたアセット、それらを保持するプロジェクト、およびジョブ履歴。

AIアセットai-projectsai-jobs
ai_studio AI Studio

コマース

3

ネットワークメンバー、見積もり依頼、回収。

ネットワークメンバー見積もり依頼コレクション
コマース コマース

電子署名

2

署名リクエストと、それらに対して収集された署名

署名リクエスト署名
署名 電子署名

承認

2

承認リクエストと、それらをルーティングするルール。

承認リクエスト承認ルール
承認 承認

ファイル

2

アップロードされたファイルとスキャンされた文書。

ファイルスキャン済み文書
ファイル ファイル

アクティビティ

3

アクティビティフィード、監査ログ、通知。

アクティビティ監査ログ通知
電話で

APIが読み取るすべてのモジュールを、チームは手元で開くことができます。

これは通常、真実ではない部分です。多くのプラットフォームは広範なAPIを公開し、承認、表示、通知の3つの機能しか持たないモバイルアプリを提供します。Kardopalのアプリは、単なるコンパニオンではなく、製品そのものです。上記の29のモジュールすべてに実際の画面があり、ほとんどの作業はスマートフォンで行われます。

  • 読んで、すぐに行動。連携機能が在庫レベルを抽出し、修正が必要な担当者は同じ記録を開いて調整し、自分の名前で署名します。
  • スキャン、撮影、署名。バーコードスキャン、ドキュメントキャプチャ、電子署名はスマートフォンに最適化されており、デスクトップには実用的な同等機能はありません。
  • レジはオフラインでも動作します。接続が不安定な場合でも、レジ、キッチン画面、順番待ち表示はサービスを提供し続けます。
  • 同じログイン、同じデータ、20言語。右から左への表記にも対応しているため、アラビア語圏のチームがレイアウトを反転して読む必要はありません。
プラットフォームを見る
スマートフォンで動作するKardopalアプリ

キーの取得

アプリを開き、プラットフォーム → APIキー に進みます。キーは、お客様のテナントの所有者または管理者によって作成されます。Kardopalの誰もお客様のためにキーを発行することはありません。
連携に必要なモジュールのみをチェックしてください。ショップウィンドウウィジェットには アイテム。必要ありません hr. 狭いキーはフェイルセーフです。
URLではなく、ヘッダーとして送信してください。X-API-Key: kp_live_… — クエリ文字列はログ、プロキシ、ブラウザ履歴に残ります。
まず新しいキーを作成してローテーションします。両方が同時に機能するため、トラフィックを移行させ、ダウンタイムなしで古い方を無効にできます。

その上に何かを構築する

APIは自己文書化されています。アプリでキーを作成し、ポイント curl ベースURLで、そのキーがアクセスできる全てのモジュール、リソース、検索可能なフィールドを返します。

APIキーを作成