本文へスキップ

はじめに:APIキーと最初の呼び出し.

KENJTEC API でできること、APIキーの作成と最初の呼び出し — すべてのエンドポイント、リスト、エラー、キーごとの制限も。

動画キーの作成
このページの内容

APIでできること

KENJTEC API を使うと、独自のプログラムからアカウントにアクセスできます。フォームとその回答、ショップと注文を読み取れるほか、書き込み も可能です。ウェブサイトの作成と公開、DNSレコードの管理、請求書の作成、メディアのアップロードができます。さらに Webhook もあり、何かが起きるとすぐに当社からお使いのサーバーへ通知します。また、お使いの AI も同じキーで MCP を通じて作業できます。

アドレスは https://api.kenjtec.com/v1 です。APIはすべての有料プランに含まれており、追加料金はかかりません。

Café Lumen のダッシュボードの「開発者」エリア:上部にAPIのアドレスと「コピー」ボタン、その下に「キーごとに毎分120件のリクエスト。」という一文。
この録画には英語の画面が表示されています。

キーの作成

各プログラムは、それぞれ専用のAPIキーでサインインします。キーには権限が付与されます。forms:read はフォームと回答を読み取り、orders:read はショップと注文を読み取り、webhooks:manage はWebhookを作成・削除します。書き込み用のエンドポイント には、領域ごとに専用の権限があります。プログラムごとに別々のキーを用意してください。そうすれば、ほかのキーに影響を与えずに特定のキーだけを無効にできます。

Ana は「開発者」エリアで「在庫同期」という名前のキーを作成し、「ショップと注文を読む」を選択して「キーを作成」をクリックします。キーが「今すぐコピーしてください。キーは二度と表示されません。」という一文とともに表示されます。この録画には英語の画面が表示されています。
  1. ダッシュボードを開き、「設定」で 開発者 を選択します。
  2. 「APIキー」でキーに名前を付けます(例:「在庫同期」)。
  3. 「このキーに許可すること」で、プログラムに必要な権限だけを選択します。
  4. 「キーを作成」をクリックし、すぐにキーをコピーします。

キーが表示されるのは一度だけです。当社が保存するのはチェックサムのみです。キーを紛失した場合は、「無効にする」で無効にしてから新しいキーを作成してください。

最初の呼び出し

すべてのリクエストで、キーを Authorization ヘッダーに含めて送信します。/v1/me を呼び出すと、キーがどのアカウントに属し、どの権限を持っているかを確認できます。

リクエスト
curl https://api.kenjtec.com/v1/me \
  -H "Authorization: Bearer kt_api_…"
レスポンス
{
  "id": 1042,
  "object": "account",
  "email": "ana@deine-firma.com",
  "handle": "cafe-lumen",
  "address": "https://cafe-lumen.kenjtec.ai",
  "key": { "name": "Lager-Abgleich", "scopes": ["orders:read"] }
}

エンドポイント

利用できるエンドポイントは次のとおりです。完全な機械可読の仕様は https://api.kenjtec.com/openapi.json にあります。これをもとに、あらゆるプログラミング言語向けのクライアントライブラリを生成できます。

GET    /v1/me
GET    /v1/forms
GET    /v1/forms/{id}
GET    /v1/forms/{id}/responses
GET    /v1/forms/{id}/responses/{id}
GET    /v1/shops
GET    /v1/orders          ?shop_id=  &status=  &payment_status=
GET    /v1/orders/{id}
GET    /v1/webhooks
POST   /v1/webhooks
DELETE /v1/webhooks/{id}

GET    /v1/sites
GET    /v1/sites/{id}
POST   /v1/sites
POST   /v1/sites/{id}/edit
POST   /v1/sites/{id}/publish
POST   /v1/sites/{id}/unpublish
GET    /v1/domains
GET    /v1/domains/{id}/dns_records
POST   /v1/domains/{id}/dns_records
PATCH  /v1/domains/{id}/dns_records/{id}
DELETE /v1/domains/{id}/dns_records/{id}
GET    /v1/customers
POST   /v1/customers
GET    /v1/invoices        ?kind=invoice|quote
GET    /v1/invoices/{id}
POST   /v1/invoices
POST   /v1/invoices/{id}/issue
POST   /v1/invoices/{id}/cancel
GET    /v1/media
POST   /v1/media/uploads
POST   /v1/media/{id}/confirm
GET    /v1/brands
GET    /v1/brands/{id}

フォームの回答に含まれるファイルは、アドレスではなくファイル名で表示されます。ダウンロードは FormBuilder で行えます。

リスト、金額、日時

リストは新しい順に返され、呼び出しごとに最大 100 件です(limit、既定値 25)。次のページを取得するには、最後の項目のIDを starting_after として送信します。has_more で、まだ続きがあるかどうかがわかります。

金額は、通貨の最小単位で表した整数です。ユーロならセント、円なら円単位です。日時はUTCで、ISO 8601 形式で表されます。

支払い済みの注文、ページごとに 50 件
curl "https://api.kenjtec.com/v1/orders?payment_status=paid&limit=50" \
  -H "Authorization: Bearer kt_api_…"

エラーと制限

すべてのエラーは同じ形式です。error オブジェクトに type と message が含まれます。401 は、キーがない、誤っている、または無効化されていることを示します。403 は、キーに必要な権限がないか、アカウントに有料プランがなくなったことを示します(type plan_required)。404 は、対象が存在しないか、あなたのアカウントに属していないことを示します。

リクエストはキーごとに毎分 120 件までです。これを超えると、APIは 429 を返し、次に試行できるまでの秒数を Retry-After で示します。

{
  "error": {
    "type": "permission_error",
    "message": "This API key lacks the scope 'orders:read'."
  }
}

APIが受け付けるのはキーだけで、ブラウザでのサインインは決して受け付けません。キーはお使いのサーバーに置いてください。ウェブサイトや、他の人がダウンロードするアプリには絶対に含めないでください。

関連ガイドと次のステップ

KENJTECの改善にご協力ください

Google Analyticsをウェブサイトの改善に利用します。Googleに利用状況と端末のデータが送信され、米国で処理される場合があります。

同意は任意です。選択は180日間保存され、Cookie設定からいつでも変更できます。

プライバシーポリシー