接続の確立

接続プロファイルの設定

［CData］リボンから［データの取得］をクリックし、［取得元：Square］> 設定済みの接続を選択してCData クエリウィンドウを起動します。新しい接続を設定するには、［新しいSquare 接続］をクリックします。ここでは、接続の設定、接続のテスト、および接続プロファイルの保存を行うことができます。

Square への接続

Square は、2種類の接続方法を提供します。

パーソナルアクセストークン経由 -- サンドボックスを介して自身のデータやテストデータに接続します。
OAuth 経由 -- ブラウザ上で共有Square データに接続します。

上記のいずれの方法も、CData Square ドライバーに組み込まれたOAuth 機能を使用します。

接続の前に

データへのアクセス方法に合わせて、OAuthAccessToken 接続プロパティを以下のように設定します。
LocationId プロパティを設定して、デフォルトのビジネスロケーションを指定します。

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

個人データに接続するには、パーソナルアクセストークンを取得してOAuthAccessToken 接続プロパティをそのトークンに設定します。

"https://developer.squareup.com/apps" からSquare Developer Dashboard に移動します。
アプリが作成されたら、Credentials タブを開いてパーソナルトークンを見つけます。

Square Sandbox

Connect API のバージョン2では、サンドボックス環境でのテストが可能です。サンドボックスで作成されたトランザクションは、カードネットワークには送信されず、カードに課金されることはありません。

サンドボックスに接続するには、サンドボックスのアクセストークンを取得してOAuthAccessToken 接続プロパティをそのトークンに設定します。

"https://developer.squareup.com/apps" からSquare Developer Dashboard に移動します。
アプリが作成されたら、Credentials タブを開いてサンドボックストークンを見つけます。

OAuth

Square はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのSquare への認証について詳しく説明します。

デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成方法と、組み込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成を参照してください。

Square で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

デスクトップアプリケーション

CData は、デスクトップでの認証を簡単にする組み込みOAuth アプリケーションを提供します。また、Square コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することもできます。詳しくは、カスタムOAuth アプリケーションの作成を参照してください。

接続の前に、以下の変数を設定します。

InitiateOAuth = GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
カスタムOAuth アプリケーションのみ：
- OAuthClientId = カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret = カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
- CallbackURL = カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI。

接続すると、本製品はデフォルトブラウザでSquare のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

アクセストークンの期限が切れたときは、本製品は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

本製品がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

はじめてデータに接続する際、次の接続プロパティを設定します。
- InitiateOAuth = REFRESH。
- OAuthClientId = アプリケーション設定のクライアントId。
- OAuthClientSecret = アプリケーション設定のクライアントシークレット。
- OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation = 本製品がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、GetOAuthAccessToken ストアドプロシージャを呼び出します。
次の接続プロパティを設定します。
- OAuthClientId = アプリケーション設定のクライアントId。
- OAuthClientSecret = アプリケーション設定のクライアントシークレット。
RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。Open は、新規接続を開きます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

認証後のオプション

Square への認証後、Locations テーブルを取得し、LocationId を設定して検索条件を選択した場所に限定できます。

接続プロパティ

最後に、Connection プロパティを参照してください。接続の確立に使用できるさまざまなオプションの説明があります。

接続の管理

Square への認証に成功すると、インポートするデータをカスタマイズすることができます。詳しくは、接続の管理を参照してください。

Excel Add-In for Square