APIキーとは何ですか?何に使うものですか?

Smartpay では、アカウントのAPIキーを使ってAPIリクエストの認証を行なっています。APIリクエストの際にAPIキーを含めないと、エラーが返されます。

各アカウントに、テストモード用のキーと実際に取引を行うライブモード用のキーの両方が付与されます。2つのモードに互換性はなく、一方のモードのAPIリクエストやオブジェクトを他方のモードで使用することはできません。

APIキーには、テストモードとライブモードに加え、公開キーと秘密キーという種類があります。

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

  • 秘密APIキー:秘密情報として取り扱う必要があり、ご自身のサーバーにのみ保管してください。秘密APIキーは決して第三者に共有しないでください。アカウントの秘密APIキーが漏洩すると、Smartpayに対してあらゆるAPIリクエストが無制限に行えてしまいます。秘密APIキーが漏洩したと判断した場合、 Smartpayはそのキーを無効化し、再発行する場合があります。その際、Smartpayのサービスに中断が生じる可能性があります。

Smartpayをご利用の加盟店様には、テストモードおよびライブモード用それぞれの公開キーと秘密キーのペア、合計4つのキーが付与されます。

Smartpay APIキーは、Smartpayのダッシュボード>プロフィール>設定>開発者ページでご確認いただけます。