認証

このページで扱うトピック

Opn PaymentsのAPIにおける認証の方法と、パブリックキーとプライベートキーの目的を説明します。

アカウント作成

Opn Payments のサービスを利用するにあたり、まず 無料アカウントの作成 を作成してください。
テスト環境が利用できるまでの登録は、わずか数分で終わります。

APIキーの適切な活用法

テストモードとライブモードそれぞれに、パブリックキー、プライベートキーの組み合わせがあります。 開発中は、テストモードのキーセットをご利用ください。 本番サーバーでは、実際に課金を行うためにライブモード用のAPIキーを使ってください。

キー 内容
pkey_test_... テストモード用パブリックキー
skey_test_... テストモード用シークレットキー
pkey_... ライブモード用パブリックキー
skey_... ライブモード用シークレットキー

パブリックキー

クレジットカード保有者データをOpn Payments まで送信する際、最初に行うのは、常にパブリックキーを使用してユーザーのブラウザ上からトークンを作成することです。
このAPIキーはトークン作成しか行うことができないため、ウェブページ上で使用しても安全です。

関連記事: 決済を行う(Card), Token API, Omise.js

シークレットキー

シークレットキーによって、Opn Payments 上でご利用のサーバーを認証します。シークレットキーはすべての非トークンAPIクエリで使用されます。ライブモード用のシークレットキーは安全性が保証されていない環境で共有や保管などをしないでください。
Opn Paymentsでは安全性のためにご利用のサーバーのAPIキーを暗号化することを強く推奨しています。

Opn Payments APIへの認証はユーザー名とシークレットキーを使用することで、HTTP Basic認証を通して行われます。パスワードは必要ありません。

シークレットキーが漏洩した恐れがある場合、Omiseアカウントにログインし、新しいAPIキーを発行してご利用のサーバー上で更新してください。更新することで、過去の認証キーは利用ができなくなります。

API呼び出し時のシークレットキー使用例

curl https://api.omise.co/customers/cust_test_4xs68oo1vgalgffzsyw/cards \
  -X GET \
  -u skey_test_4xs68olyuul9lmmp375: \
  -d "offset=50" \
  -d "limit=10"
Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら