APIキーとは何ですか、そして何に使うものですか。

Smartpayでは、アカウントのAPIキーを用いてAPIリクエストの認証を行っています。APIリクエストを行う際、キーを含めなければ、Smartpayはエラーを返します。

全てのアカウントに対して、テスト用のキーと本番の取引実行用のキーを別々に準備しています。テストモードであれ本番モードであれ、どのAPIリクエストもオブジェクトももう片方のモードとは互換性がありません。

APIキーには、テストモードと本番モードの区別に加えて、公開または非公開というタイプの区別もあります。

  • 公開:公開APIキーは、Smartpayのアカウントを特定することのみを目的とするもので、非公開ではありません。つまり、Smartpay.js JavaScriptコード、もしくはAndroidまたはiPhoneアプリなど、人目に触れるところで使用しても問題ありません。

  • 非公開:非公開APIキーは、秘密情報として取り扱う必要があり、自前のサーバーにしか保管できません。非公開APIキーは、一切の第三者と共有できません。アカウントの非公開APIキーが漏洩すると、何の制約もなくSmartpayに対してあらゆるAPIリクエストの実行が可能になってしまう危険があります。非公開APIキーが漏洩したとSmartpayが判断した場合、Smartpayはかかるキーを無効化して再発行できるものとします。その際には、Smartpayサービスに中断が生じる可能性があります。

Smartpayを本番環境でご利用の提携店舗様は、テストモードおよび本番モードそれぞれについて、公開可能なキーと非公開キーのペア、合計で4つのキーを持つことになります。

Smartpay APIキーは、Smartpayのダッシュボードの設定>ログイン情報ページで確認できます。