連絡先
2顧客、サプライヤー、そしてそれらが属するセグメント。
連絡先連絡先セグメントここで真実となる、通常とは異なる6つのこと。
ベースURLにアクセスすると、APIは自身のカタログを返します。キーでアクセスできるすべてのモジュール、その内部のすべてのリソース、検索可能なフィールドとフィルタリング可能なフィールド。このページは連携を記述するために必要なのではなく、連携を決定するために必要です。
アプリ内のスコープ、ルート、権限ピルは一つのリストから生成されるため、エンドポイントがなければ権限は提供されません。キーのスコープは アイテム アイテムを取得します — 給与計算を要求すると、静かな空のページではなく403エラーが返されます。
検索, 以来, まで, スキップ と 取得 請求書上でも在庫移動上でも同じ意味を持つ。一度形を覚えれば、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 |
取得 | 何行を返すか | デフォルトは50、上限は200 |
リソースは、自身が宣言するフィールドに対する完全一致フィルターも受け付けます ?status=paid, ?warehouseId=… — そしてそれぞれがそれらが何であるかを宣伝します。すべてのリスト応答には 合計 と さらに表示、そのため、ページングは推測ではなくループです。
29のモジュール、129のリソース。各カードはキーに付与できる1つの権限であり、灰色のタグはスマートフォンのアプリで同じレコードが存在する場所を示します。
顧客、サプライヤー、そしてそれらが属するセグメント。
連絡先連絡先セグメントカタログ:製品、バリエーション、ブランド、価格表、単位。
アイテムカテゴリブランド商品バリアント価格表単位+1件倉庫、在庫レベル、移動、ロット、シリアル、棚。
倉庫在庫移動在庫レベルバッチserials棚卸し+1件請求書、見積書、注文書、クレジットノート、支払い。
請求書見積もり販売注文クレジットノート支払い定期請求書+1件レジ、シフト、レシート、テーブル、そしてカウンターを越えたすべての販売。
POS売上POSシフトPOS端末POSユーザーPOSテーブルPOSテーブルエリアその他5件リード、商談、パイプライン、提案。
リードdealsパイプライン提案書発注書、依頼、返品、請求書、仕入先への支払い。
発注書購買依頼仕入返品請求書仕入先への支払い経費、銀行口座、取引、税率。
経費経費カテゴリ銀行口座bank-transactions税率キャンペーン、受信者、ランディングページ、フォーム送信。
キャンペーンキャンペーン受信者ランディングページフォーム送信人事、部署、休暇、給与明細、勤怠、採用。
従業員部門leave-requests給与明細出席求人情報+2件その他タイムエントリーと、それらが計上されるプロジェクト。
時間記録タイムシートプロジェクトプロジェクト、フェーズ、およびそれらに付随する費用。
プロジェクトプロジェクトフェーズプロジェクト費用予約、予約可能なサービス、およびそれらを提供するスタッフ。
予約予約サービススタッフ予約ジョブ、技術者、作業指示、契約、設備。
現場作業技術者service-requestsサービス契約作業指示書ジョブカード+1件出荷、ドライバー、車両、ゾーン、運送業者。
出荷ドライバー車両配送エリア運送業者チケット、SLAポリシー、ヘルプ記事、ナレッジベース。
チケット顧客チケットヘルプ記事ナレッジベースSLAポリシー返品、保証請求、修理、製品登録。
RMA保証請求保証登録修理製品登録貸出可能な資産、レンタル契約、およびその明細。
資産レンタルレンタルラインメニューとそれに対する注文。
メニュー項目メニュー注文チケット、サービス、カウンター、支店、およびディスプレイ画面。
整理券順番待ちサービスキューカウンターキューブランチ順番待ち表示会員、アカウント、ティア、特典、ポイント取引。
loyalty-membersポイント・会員管理ロイヤリティ特典ロイヤルティティアロイヤリティ取引loyalty-couponsサイトと支店。
拠点支店デバイス、サイト、ボックス、アラート、イベント、サイネージコンテンツ。
iot-devicesiot-sitesIoTアラートiot-eventsIoTボックスIoTサイネージコンテンツ生成されたアセット、それらを保持するプロジェクト、およびジョブ履歴。
AIアセットai-projectsai-jobsネットワークメンバー、見積もり依頼、回収。
ネットワークメンバー見積もり依頼コレクション署名リクエストと、それらに対して収集された署名
署名リクエスト署名承認リクエストと、それらをルーティングするルール。
承認リクエスト承認ルールアップロードされたファイルとスキャンされた文書。
ファイルスキャン済み文書アクティビティフィード、監査ログ、通知。
アクティビティ監査ログ通知これは通常、真実ではない部分です。多くのプラットフォームは広範なAPIを公開し、承認、表示、通知の3つの機能しか持たないモバイルアプリを提供します。Kardopalのアプリは、単なるコンパニオンではなく、製品そのものです。上記の29のモジュールすべてに実際の画面があり、ほとんどの作業はスマートフォンで行われます。
アイテム。必要ありません hr. 狭いキーはフェイルセーフです。X-API-Key: kp_live_… — クエリ文字列はログ、プロキシ、ブラウザ履歴に残ります。APIは自己文書化されています。アプリでキーを作成し、ポイント curl ベースURLで、そのキーがアクセスできる全てのモジュール、リソース、検索可能なフィールドを返します。