blanc API Docs

はじめに

blanc API を利用するための前提条件（ネットワーク・認証・文字コードの要件）をまとめます。以下の要件を満たしたうえで、認証ガイドの手順に沿ってアクセストークンを取得し、最初のリクエストを送ってください。

ネットワーク・認証要件・文字コード

本APIの利用にあたり、以下のネットワーク要件および認証設定が必要となります。

1. 接続先ホスト（ポート番号：443）

環境により接続先ホストが異なります。

  • 本番環境：https://blanc-karte.jp（本番施設とテスト施設は同一URLですが、クライアント証明書により区別されます）
  • サンドボックス環境：https://sandbox.blanc-karte.jp

2. 通信プロトコル

インターネット回線に接続され、TLS 1.3 以上のプロトコルによるHTTPS接続が必要です。

3. クライアント証明書

接続には亀田医療情報株式会社が発行するクライアント証明書が必要です。環境ごとに利用する証明書が異なります。

  • 本番環境・サンドボックス環境：共通のクライアント証明書を使用
  • テスト環境：テスト環境専用のクライアント証明書を使用
  • 証明書の有効期限：発行から5年間

4. 文字コード

文字コードは UTF-8 になります。

流量制限（レートリミット）

本APIの流量制限は原則アプリケーションID単位で分間60リクエストです。

  • 制限単位：アプリケーションID
  • 制限値：60 リクエスト / 分（原則）
  • 制限方式：1分間の固定ウィンドウ（ウィンドウ経過でリクエストカウントをリセット）
  • 超過時：HTTPステータス 429（エラーコード [E01]）を返却

※制限値は契約内容やアプリケーションIDごとに個別に設定される場合があります。

次のステップ