API連携
API ドキュメント
クリニック管理システムと外部システムを連携するためのAPIをご提供しています
API概要
当プラットフォームでは、RESTful APIを提供しており、クリニックの既存システムや カスタムアプリケーションとの連携が可能です。
RESTful API
標準的なREST API形式
認証
APIキーによる認証
Webhook
イベント通知に対応
利用可能なAPI
予約管理API
予約の作成・取得・更新・削除が可能
エンドポイント:
- POST /api/bookings
- GET /api/bookings
- PUT /api/bookings/:id
- DELETE /api/bookings/:id
患者管理API
患者情報の取得・更新が可能
エンドポイント:
- GET /api/patients
- GET /api/patients/:id
- PUT /api/patients/:id
処方管理API
処方情報の作成・取得・更新が可能
エンドポイント:
- POST /api/prescriptions
- GET /api/prescriptions
- PUT /api/prescriptions/:id
決済管理API
決済情報の取得・Webhook処理が可能
エンドポイント:
- GET /api/payments
- POST /api/webhooks/payment
認証方法
APIキー認証
すべてのAPIリクエストには、認証用のAPIキーが必要です。APIキーは管理画面から取得できます。
Authorization: Bearer YOUR_API_KEY※APIキーは機密情報です。外部に公開しないようご注意ください。
レート制限
標準プラン
1分あたり100リクエスト
プレミアムプラン
1分あたり500リクエスト
サンプルコード
予約作成の例（JavaScript）
fetch('https://api.clinic-portal.com/api/bookings', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
patientId: 'patient_123',
clinicId: 'clinic_456',
date: '2024-01-15',
time: '10:00'
})
})
.then(response => response.json())
.then(data => console.log(data));