Square API SDK プラグインを使ってみる

よたか2020.09.05 04:29:37

Squareを使って6つの簡単なステップで構築を開始します。

ステップ1：Squareアカウントを作成する
ステップ2：新しいアプリケーションを作成する
ステップ3：アプリケーション設定ページを理解する
ステップ4：さまざまなアプリケーションの資格情報を理解する
ステップ5：試してみる
ステップ6：構築を開始します！

■ステップ1：Squareアカウントを作成する

Squareは、オンライン決済（eコマース）、対面決済（販売時点）、製品管理、顧客管理、ビジネス管理など、さまざまな問題を解決するために連携するAPIのコレクションを提供します。
Square APIを使用するには、Squareアカウントを作成するか、既存のアカウントにログインする必要があります。

重要

Square APIによるクレジットカードとカードオンファイル処理のサポートは、現在、米国、カナダ、日本、オーストラリア、英国に限定されています。
現金支払いと非支払いAPI機能（従業員管理、タイムカード、カタログなど）は、Squareアカウントが利用可能なすべての場所でサポートされています。

■ステップ2：新しいアプリケーションを作成する

新しいアプリケーションを作成するには：

アプリケーションダッシュボードを開きます。
New Application をクリックします。（またはアカウントが新しい場合は、Create Your First Application）
アプリケーションの名前を入力します。
Square Developer の利用規約に同意する
Create Application をクリックします。

注意

サンドボックスですぐに支払い処理をテストできます。本番環境で支払いを処理するには、 squareup.com/activate にアクセスして、対象のアカウントで支払い処理をアクティブにする必要があります。そうしないと、Squareからエラーが返されます。

■ステップ3：アプリケーション設定ページを理解する

手順2で作成したアプリケーションをクリックして、アプリケーション設定ページを開きます。アプリケーション設定ページには、アプリケーションの開発中に必要になる可能性のあるさまざまな値と設定を持つ複数のページが含まれています。

【Credentials】プロダクションおよびサンドボックスのアプリケーション Credentials（資格情報）を管理します。
【OAuth】カスタムソリューションのOAuthワークフローを管理します。
【Webhook】Webhook（指定したURLにPOSTリクエスト）を設定して有効にします。
【Reader SDK】カスタムモバイルソリューションのReader SDKを構成します。
【POS API】カスタムモバイルソリューションのPOS APIを構成します。
【Apple Pay】Square支払いフォームを使用して、eコマースソリューション用に Apple Pay on the Webを設定します。
【Locations】Squareアカウントの本番およびサンドボックスの場所IDを表示します。ロケーションIDは、便宜上、アプリケーションコントロールパネルに一覧表示されます。

重要

アプリケーションダッシュボードはデフォルトでサンドボックス設定モードになり、サンドボックス環境のアプリ認証情報を提供します。アプリを本番環境にデプロイする準備ができたら、ダッシュボードを本番設定モードに設定し、アプリ構成コードのサンドボックス認証情報を本番認証情報に置き換えます。

■ステップ4：さまざまなアプリケーションの資格情報を理解する

アプリケーション設定ページは、Squareサービスにアクセスするためのさまざまな資格情報を提供します。アプリケーションの使用方法に応じて、異なる資格情報を使用する必要があります。

異なるアプリケーション認証情報については、Squareアプリケーション認証情報タイプについてお読みください。

■ステップ5：試してみる

以下のツールでサンドボックスアクセストークンとロケーションIDを使用して、クレジットカードの支払いを処理するためのテストナンスを含む支払いリクエストを送信します。

アプリケーションサンドボックスの認証情報を取得する。

開発者ダッシュボードを開き、アプリケーションを選択します。選択したアプリの認証情報ページが表示されます。
ダッシュボードモードを、プロダクションアプリケーションIDのプロダクション設定またはサンドボックスアプリケーションIDのサンドボックス設定（テストで使用）に設定します。
サンドボックスアプリケーションIDとサンドボックスアクセストークンをページの[認証情報]セクションにコピーします。

コマンドライン

Macを使用している場合は、ターミナルを開きます。 Windowsを使用している場合は、PowerShellセッションを開きます。

{{ACCESS_TOKEN}} を Sandbox Personal Access Token に置き換えて Authorization ヘッダーを更新します。
コマンドのペイロードのデフォルトのJSONブロックを更新します。
- idempotency_keyを一意の文字列（TESTKEY123など）に設定します。
- source_idをcnon：card-nonce-okに設定します。
コマンドをコピーしてコマンドラインに貼り付けます。
コマンドを実行する。

TERMINAL


curl -X POST \

-H 'Accept: application/json' \

-H 'Authorization: Bearer {{ACCESS_TOKEN}}' \

-H 'Cache-Control: no-cache' \

-H 'Content-Type: application/json' \

-d '{

	"idempotency_key": "{{UNIQUE-KEY}}",

	"autocomplete": true,

	"amount_money": {

		"amount": 100,

		"currency": "USD"

	},

	"source_id": "cnon:card-nonce-ok"

	}

}' \

'https://connect.squareupsandbox.com/v2/payments'

ステップ6：構築を開始します！

Square Developer Platform は、さまざまな開発ツールを提供します

【Square API Suite】オンライン決済、項目別トランザクションの注文作成、製品カタログ管理、顧客管理、および従業員の時間管理をサポートします。
【Webhook】Squareカタログ、在庫、レイバーAPIのプッシュ通知をサポートします。今後のSquare API リリースでは追加のWebhookがサポートされる予定です。
【Sandbox】分離されたサンドボックステスト環境で Square API スイートをサポートします。サンドボックス環境での API操作に関する Webhook通知もサポートします。
【Square SDK】Connect v1 および Square API スイートをカプセル化することで開発を簡素化します。 Square SDK は、PHP, Node.js, Ruby, Python, Java および .NET で利用できます。
【Connect v1 API Suite】ほとんどのv1エンドポイントは非推奨になり、Square API エンドポイントに置き換えられました。 Connect v1 は、主に下位互換性のために提供されています。既存のv1アプリケーション開発者は、Square API 移行ガイドを使用して、Square API スイートへの移行について学ぶことができます。
【Mobile APIs and SDKs】モバイルWebおよびカスタムモバイルアプリケーションの対面決済をサポートします。
- 【Reader SDK】ネイティブの Android および iOSアプリで支払いを受け入れます。
- 【Point of Sale API】ネイティブの Android と iOS 、およびモバイルWebアプリから Square Point of Sale アプリを呼び出します。
- 【In-App Payments SDK】購入者のデバイスのネイティブ Android および iOSアプリで支払いを受け入れます。
【Open Source Plugins】マルチプラットフォームアプリケーション開発フレームワークでの開発をサポートします。プラグインは、Reader SDK（Flutter、React Native）および In-App Payments SDK（Flutter、React Native）で利用できます。

知ってますか？

API Explorer, Postman, Paw, Insomnia などの HTTPS リクエストツールを使用して、開発中にAPIリクエストをすばやく簡単にテストできます。 HTTPS リクエストツールは、カスタマイズされた環境と API 呼び出しのパラメーター化を提供し、コードを記述しなくてもエンドポイントを呼び出すことができます。

事前設定されたAPIコレクションの使用の詳細については、Postman を使用した Square API のテストを参照してください。

このページは個人的に使用するために Square Developer のページを翻訳したものです

ミントのスキン