認証

KOMOJUは、マーチャントに2種類のAPIキーを提供しています：非公開鍵と公開鍵。これらの鍵はAPIリクエストを行うために必要であり、マーチャントアカウントの設定ページで確認することができます。各マーチャントアカウントには、LIVE環境とTEST環境の両方の鍵ペアがあります。

APIリクエストはHTTP Basic Authenticationを通じて認証されます。認証するには、APIキーをユーザー名として使用し、パスワードフィールドは空白のままにします。例：

curl -u secret_key: "https://komoju.com/api/v1/payments"

非公開鍵はすべてのAPIリソースへのアクセスを許可します。この鍵を持った者はアカウント上で様々なアクションを実行する可能性があるため、厳重に保管することが重要です。非公開鍵はサーバーサイドに保管し、クライアントサイドのアプリケーションには絶対に公開しないようにしてください。

非公開鍵とは異なり、公開鍵が対応するAPIリソースが限られています。公開鍵は公開しても安全であり、ダメージを引き起こすことはありません。

以下のAPIは公開鍵を使用して実行することができます：

互換性を確保し、後方互換性を維持するために、KOMOJU は、カスタムヘッダによるAPIリソースのバージョン管理をサポートしています。有効なバージョンを指定するのにはAPIリクエストに X-KOMOJU-API-VERSION のヘッダーを使用することができます。

curl -H 'X-KOMOJU-API-VERSION: 2024-07-15' -u secret_key: "https://komoju.com/api/v1/payments"

また、KOMOJU のダッシュボードから、非公開鍵と公開鍵の経由でAPI バージョンを指定することもできます。KOMOJUのダッシュボードにログイン　＞　メニューにある「設定」に移動し、非公開鍵や公開鍵の横にある編集ボタンをクリックし、APIバージョンを設定することができます。