注:このページは、開発者ドキュメントの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を使用したカードの支払い処理を検討している場合、アカウントを作成した後、そのアカウントでカード決済機能が有効になっていることを確認してください。 カード決済機能が有効化されておらず、サンドボックスを使用しない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] タブにはさまざまな認証情報が含まれ、複雑になっています。以下で簡単に説明します。

パーソナルアクセストークン

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

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

アプリケーションID

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

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

* その他のSquare加盟店が使用するアプリケーションを開発している場合、OAuthフローでこの値を指定します (後述)。
* Eコマース APIを使用している場合、ウェブサイトに安全な支払いフォームを組み込むときにこの値を指定します。

アプリケーションシークレット

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

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

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

サンドボックスアプリケーションIDとアクセストークン

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

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

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

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

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