Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
Login
Pay-Doc Pay-Doc
Login
Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
loading
  1. Home
  2. APIリファレンス
  3. 一般
  4. 認証
Updated on 2025年4月15日

APIリファレンス

  • Folder icon closed Folder open icon一般
    • API連携、SDKについて
    • 認証
    • APIの制限
    • レスポンス
    • ページネーション
    • メタデータ
    • ポーリング
    • 冪等なリクエスト
    • 通貨と為替レート
  • Folder icon closed Folder open iconトランザクショントークン
    • トランザクショントークン – 概要
    • トランザクショントークン – リクエスト
      • トランザクショントークン – CREATE
      • トランザクショントークン – GET
      • トランザクショントークン – LIST
      • トランザクショントークン – UPDATE
      • トランザクショントークン – DELETE
      • トランザクショントークン – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon課金
    • 課金 – 概要
    • 課金 – リクエスト
      • 課金 – CREATE
      • 課金 – GET
      • 課金 – GET(銀行振込)
      • 課金 – LIST
      • 課金 – UPDATE
      • キャプチャ – CREATE
      • イシュアトークン – GET
      • 課金 – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon定期課金
    • 定期課金 – 概要
    • 定期課金 – リクエスト
      • 定期課金 – CREATE
      • 定期課金 – GET
      • 定期課金 – LIST
      • 定期課金 – UPDATE
      • 定期課金 – CANCEL
      • 定期課金 – 課金 – LIST
      • 支払い – 概要
      • 支払い – GET
      • 支払い – LIST
  • Folder icon closed Folder open icon返金
    • 返金 – 概要
    • 返金 – リクエスト
      • 返金 – CREATE
      • 返金 – GET
      • 返金 – LIST
      • 返金 – UPDATE
  • Folder icon closed Folder open iconキャンセル
    • キャンセル – 概要
    • キャンセル – リクエスト
      • キャンセル – CREATE
      • キャンセル – GET
      • キャンセル – LIST
      • キャンセル – UPDATE
  • Folder icon closed Folder open iconトランザクション
    • トランザクション – 概要
    • トランザクション – リクエスト
      • トランザクション – LIST
  • Folder icon closed Folder open icon加盟店
    • 加盟店 – 概要
    • 加盟店 – リクエスト
      • 加盟店 – GET
  • Folder icon closed Folder open icon店舗
    • 店舗 – 概要
    • 店舗 – リクエスト
      • 店舗 – GET
      • 店舗 – LIST
      • カスタマーUUID
  • Folder icon closed Folder open icon決済設定
    • 決済設定 – 概要
    • 決済設定 – リクエスト
      • 決済設定 – GET
  • Folder icon closed Folder open iconウェブフック
    • ウェブフック – 概要
    • ウェブフック – リクエスト
      • ウェブフック – GET
      • ウェブフック – UPDATE
  • Folder icon closed Folder open iconエラーコード
    • エラーコード – 概要
  • Folder icon closed Folder open icon3-DセキュアをAPIで実装する
    • 3-Dセキュア認証の処理の流れ
    • 実装方法
    • 追加されるパラメータ
    • 3-Dセキュア認証情報を自社で取得している場合の対応

認証

本サービスのAPIは、認証の為に JWT(JSON Web Token) を利用しています。

ヘッダで認証を行い、ペイロード部分にリクエストを記述するのが基本的な使い方です。

アプリケーショントークンの構成

はじめに、ガイドの初期設定に従い、アプリケーショントークン(以降「アプリトークン」)を作成してください。

アプリケーショントークンは、「トークン」と「シークレット」の2部で構成されます。

シークレットは、アプリトークンを作成した時だけ表示されます。
表示されたシークレットは、くれぐれも忘れずに控えるようにしてください。

また、このシークレットは機密情報として取り扱う必要があります。
消費者のブラウザ上で実行されるようなフロントエンドアプリケーションのコードの中にシークレットを記述したり、インターネットで第三者が閲覧できる状態にしないでください。
レポートの生成、ブラウザ以外の経路での課金の作成など、サービスのバックエンドでの処理で利用されることを想定している、たいへん大きな権限を行使できる情報です。

当社では、加盟店さまのシークレットの管理上の問題に起因する事故について、一切の責任を負いかねます。

アプリトークンの使い方

以降、全てのページで、HTTPリクエストヘッダのAuthorizationに記述する

  • アプリトークンを「{jwt}」
  • シークレットを「{secret} 」

と、それぞれ記述します。

Bearer認証の記述例

// シークレットなし
Bearer {jwt}

// シークレットあり
Bearer {secret}.{jwt}

アプリトークンの種類

管理画面からは、2種類のアプリトークンを作成可能です。
それぞれの意味合いと役割を表にしたものが以下です。

名前アプリトークンの権限シークレットの要否
加盟店トランザクショントークンと課金の作成のみ不可必要
店舗その「店舗」に対する全てのリクエストが可能ブラウザ上では不要
バックエンドからAPIへリクエストする際には必要
※現在は1つの「加盟店」に対し複数の「店舗」を登録しない運用をしていますので、現実的には「加盟店」権限のアプリトークンは発行・活用の価値がありません。

ウィジェットやインラインフォーム出力リクエストは、登録したドメインからであることを認証しています。
管理画面で「店舗」のアプリトークンを作成する際には、ドメインを登録してください。

Share this Doc

認証

Or copy link

Clipboard Icon
CONTENTS

© All Rights Reserved by UNIVA Paycast Limited.