認証ガイド

blanc API のすべてのリクエストには認証が必要です。事前に亀田医療情報株式会社より払い出されたアプリケーションID/パスワードを用いてアクセストークンを取得し、各リクエストに付与します。接続に必要なネットワーク要件・クライアント証明書についてははじめにを参照してください。

APIの利用方法

事前に亀田医療情報株式会社より払い出されたアプリケーションID/パスワードが必要です。

1. トークンの取得(POST /api/app-token/v1)

curl -X 'POST' 'https://blanc-karte.jp/api/app-token/v1' \
-H 'Content-Type: application/json' \
-d '{"applicationId": "[利用申請書のアプリケーションID]","appSecret": "[利用申請書のパスワード]"}'

サンプル:トークンの取得結果

{"access": "[アクセストークン]","refresh": "[リフレッシュトークン]"}

2. 各APIの利用:取得したアクセストークンを Authorization ヘッダーに付与してください。
※Swagger UI の場合は [Authorize] ボタンからトークンを登録してください。

サンプル:患者IDによる、患者基本情報の取得

curl -X 'GET' 'https://blanc-karte.jp/api/patients/v1/0000001' \
-H 'accept: application/json' \
-H 'Authorization: Bearer [アクセストークン]'

3. トークンの更新(POST /api/app-token/v1/refresh)
有効期限は1時間です。期限前にリフレッシュトークンで再取得してください。
※初回認証から18時間を超えた場合は、再度 1. の認証が必要です。

curl -X 'POST' 'https://blanc-karte.jp/api/app-token/v1/refresh' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [アクセストークン]' \
-d '{"refresh": "[リフレッシュトークン]"}'

トラブルシューティング

401 / 403 が返る場合の確認事項はエラーハンドリングを参照してください。