KeycafeのアプリケーションはREST APIを採用しており、APIキーの発行やWebhookの受信により、独自アプリケーションとのシームレスな連携開発が可能です。このガイドでは、KeycafeアプリでのAPIキー生成手順や、貴社サーバーへKeycafeのAPI Webhookを連携する手順をわかりやすく解説します。
KeycafeのAPIに関する詳細な仕様については、APIリファレンスをご確認ください。
APIキーの発行手順
画面右上のユーザードロップダウンをクリックし、 マイアカウントを選択します。
詳細設定を選択します。
API設定を選択します。
キーを生成を選択します。
新しいキーを発行する際の注意点
新しいキーを生成すると、以前に発行されたキーを使用したAPIリクエストは機能しなくなります。必ず古いAPIキーを新しく生成したキーへ差し替えてください。
詳細については、 APIリファレンスをご確認ください。
API Webhookの連携手順
画面右上のユーザードロップダウンをクリックし、 マイアカウントを選択します。
詳細設定を選択します。
API設定を選択します。
Webhook セクションで、Webhook URLとユーザー名、パスワードを入力します。
更新 を選択して連携を完了します。
Webhook連携のテスト
Webhookの連携設定が完了したら、連携テスト 機能を選択して動作を確認できます。
APIキーの削除手順
画面右上のユーザードロップダウンをクリックし、 マイアカウントを選択します。
詳細設定を選択します。
API設定を選択します。
キーを削除を選択し、確認します。