スクエアへのユーザー招待操作をAPIで行う

ここでは、API経由でスクエアへの招待操作をする方法をご説明します。


1. アクセストークンの取得

使用実績報告APIにリクエストを送信するには、事前にOAuth 2.0 認証フローを使用してアクセストークンを取得する必要があります。
ユーザー認証の連携で作成した認証情報を使用し、WebAPIに使用するアクセストークンを取得します。

Authorization Codeによるアクセストークンの取得方法については、こちらのページをご覧ください。

スクエアへの詳細操作を行うためのアクセストークンには、「api:square:invite」スコープが必要となります。


2. スクエアへの招待操作

スクエアへの招待操作は「一覧の取得」,「招待の作成」,「招待のキャンセル」の3つの操作を行うことができます。


リクエスト

GET /v1/squares/<square_id>/invitations 一覧の取得
POST /v1/squares/<square_id>/invitations 招待の作成
DELETE /v1/squares/<square_id>/invitations 招待のキャンセル
プレースホルダー説明
<square_id>
招待操作を行うスクエアのIDを指定します。

ヘッダー情報やリクエストボディの詳細につきましては、こちらをご覧ください。