注:このページは、開発者ドキュメントのSquare APIs: Getting Started(英文)を便宜上一部抄訳した内容となります。

Squareでは、加盟店のさまざまな使用ケースに応じてAPIを提供しています。最も一般的な使用例は次のとおりです。

Eコマース セキュリティで保護され、カスタマイズ可能なウェブ上のフォームにより、オンラインで支払いを受け付けることができます。過去の決済についても払い戻し処理が行えます。

対面での商取引: 独自のiOS/Android POSアプリケーションでSquare Register APIを利用することで、Squareの周辺機器を使って安全に支払いを処理できます。

レポート: 自社システムに取引履歴や入金履歴のほか、商品や在庫の情報に関する詳細を取り込むことができます。

従業員管理: 従業員の就業時間を追跡したり、Square POSレジでの払い戻し処理を行ったり、従業員にアクセス権限を設定したりすることができます。

実際に使ってみるには、この記事に書かれたステップを実行しSquare APIに慣れ親しむ必要があります。Square APIを使用するにはプログラミングの経験が必要です。

Step 1: Squareアカウントを作成

Square開発者向けアカウントは、Square加盟店アカウントと同じです。Squareアカウントをすでにお持ちの場合、別途アカウントを作る必要はありません。 Squareアカウントをまだお持ちでない場合、アカウントを作成するとAPIを使用できるようになります。
Square APIを使用したクレジットカード決済を検討している場合、アカウントを作成した後、そのアカウントでカード決済機能が有効になっていることを確認してください。 カード決済機能が有効化されていない状態で決済をご利用頂く場合、エラーとなる場合があります。なお、カード決済を試すためのサンドボックス環境を用意しております。(後述)

Step 2: Squareでアプリケーションを登録

Squareアカウントを作成したら、こちらからログインします。 ログインすると、アプリケーションのダッシュボードが表示されます。ここで新しいアプリケーションの登録、アプリケーション設定の変更、アプリケーション認証情報の検索などを行います。

最初のアプリケーションを登録するには、次の手順を行います。

  1. [+New Application] をクリックします。
  2. 任意のApplication Nameを入力して、[Create Application] をクリックします (Application NameにSquareの文字を含めることはできません)。

アプリケーションを作成すると、そのアプリケーションのコントロールパネルが表示されます。コントロールパネルは4つのタブ (Credentials、OAuth、Webhook、Register API) で構成され、それぞれが複数のセクションに分かれています。

Step 3: アプリケーション認証情報について

アプリケーションのコントロールタブである [Credentials] タブと [OAuth] タブにはさまざまな認証情報が含まれています。以下で簡単に説明します。

パーソナルアクセストークン(Personal Access Token)

コントロールパネルの [Credential] タブにあります。

自分のSquareアカウントでAPIにフルアクセスできる特別なトークンです。 HTTPSリクエストをSquare APIエンドポイントに送信する際、この値をID識別用としてヘッダーに組み込みます。 自分専用のアプリケーションを開発する場合、使用する必要のある唯一のアクセストークンとなります。

アプリケーションID(Application ID)

コントロールパネルの [Credential] タブにあります。

これはアプリケーションの固有IDです。次のような場所で使用されます。

* その他の加盟店も使用するアプリケーションを作成する場合、OAuthフローでこの値を指定します(後述)。
* Eコマース APIを使用する場合、ウェブサイトに安全な決済を組み込む際にこの値を指定します。

アプリケーションシークレット(Application Secret)

コントロールパネルの [OAuth] タブにあります。

他の加盟店が使用するアプリケーションを開発している場合、OAuthフローでアプリケーションIDを確認するためにこの値を使用します。

名前のとおり、この値はシークレットです。不正に使用された可能性がある場合、アプリケーションのコントロールパネルで [Show Secret] - [Replace Secret] をクリックして、値を置き換えます。

サンドボックスアプリケーションIDとアクセストークン(Sandbox Application ID / Sandbox Access Token)

コントロールパネルの [Credentials] タブにあります。

Eコマース APIは、サンドボックスによって、実際にお金を動かさずにクレジットカード決済を試すことができるようになっています。

サンドボックスモードでEコマースの決済処理を行うには、標準のアプリケーションIDおよびパーソナルアクセストークンを設定する箇所に、サンドボックスモードのアプリケーションIDとアクセストークンを設定します。

Step 4以降では、具体的な開発作業に入ります。詳細はこちらの開発者ドキュメント(英文)をご覧ください。

開発者ドキュメントのSquare API FAQ はこちら(英文)からご確認ください。