LoginSignup
0
1

More than 5 years have passed since last update.

Square APIにおけるOAuthのscopeの種類

Posted at

OAuthでは付きもののスコープ、もちろんSquareのOAuthにも存在します。デフォルトのスコープは以下になります。

  • MERCHANT_PROFILE_READ
    ビジネスプロフィール情報の閲覧。氏名、プロフィール画像、Eメールアドレスが含まれます。
  • PAYMENTS_READ
    振込履歴の閲覧。すべての振込情報が含まれます。
  • SETTLEMENTS_READ
    銀行口座情報のサマリーの閲覧。口座種類、支店番号、および口座番号の末尾が含まれます。
  • BANK_ACCOUNTS_READ
    支払履歴の閲覧。すべての取引および払戻情報が含まれます。

Screenshot_ 2017-09-14 17.52.58.png

デフォルトは読み込み系ですが、書き込み系のスコープも用意されています。

PAYMENTS_WRITE

PAYMENTS_WRITE.png

支払および払戻の作成。EコマースAPIを使う場合には必須のスコープです。

CUSTOMERS_READ

CUSTOMERS_READ.png

顧客連絡先情報の読み取り。

CUSTOMERS_WRITE

CUSTOMERS_WRITE.png

顧客連絡先情報の書き込み、編集、削除。ファイル上に保存されたクレジットカード情報も含まれます。

ITEMS_READ

ITEMS_READ.png

商品ライブラリの閲覧。

ITEMS_WRITE

ITEMS_WRITE.png

商品、販売価格、ディスカウントの追加と編集が可能になります。

ORDERS_READ

ORDERS_READ.png

注文履歴の閲覧。

ORDERS_WRITE

ORDERS_WRITE.png

注文の作成と完了、キャンセル、払い戻しといった操作ができます。

EMPLOYEES_READ

EMPLOYEES_READ.png

従業員情報の閲覧。

EMPLOYEES_WRITE

EMPLOYEES_WRITE.png

従業員情報の編集。氏名、役職、アクセス権限の追加または変更ができます。

TIMECARDS_READ

TIMECARDS_READ.png

従業員のタイムカード情報の閲覧。

TIMECARDS_WRITE

TIMECARDS_WRITE.png

タイムカードの追加または変更を許可します。


このようなスコープが用意されていますので、アプリに必要な権限をそれぞれ求めるようにしてください。店舗ID(location.id)はほぼすべてのAPIで必要になるでしょう。またEコマース系であればPAYMENT_WRITE権限は必須になるでしょう。

Square Connect API Documentation

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1