接続の確立
接続プロファイルの設定
[CData]リボンから[データの取得]をクリックし、[取得元:Smaregi]> 設定済みの接続 を選択してCData クエリウィンドウを起動します。新しい接続を設定するには、[新しいSmaregi 接続]をクリックします。ここでは、接続の設定、接続のテスト、および接続プロファイルの保存を行うことができます。
Smaregi への接続
Smaregi は、2種類の異なるAPI を通じてデータへのアクセスを提供しています。使用するAPI は、Schema 接続プロパティに以下のいずれかを設定することで指定します。- Smaregi:旧API です。
- PlatformAPI:新しいAPI です。
Smaregi への認証
使用できる認証方式は、接続先のAPI によって異なります。- Access Token:Smaregi API でのみ利用可能です。
- OAuth Client:Platform API でのみ利用可能です。
- OAuth:Platform API でのみ利用可能です。
アクセストークン
この方法を使用して接続するには、AuthScheme をAccessToken に設定し、次のプロパティを設定します。- ContractId:Smaregi アカウントに関連付けられた契約ID。
- AccessToken:Smaregi アカウントから生成されたアクセストークン。
これらの値を取得するには、Smaregi にログインし、 [設定]>[システム連携]>[スマレジAPI 設定]に移動します。API 受信設定 セクションで、受信機能を利用するを利用するに設定し、アクセストークン発行をクリックしてアクセストークンを取得します。契約ID もこのセクションに表示されます。機能設定セクションで、 必要なAPI 機能を有効にします。
OAuth Client
OAuth Client 認証は、OAuth クライアントクレデンシャルフローに従います。
この方法を使用して接続するには、カスタムOAuth アプリケーションの作成 で説明されているようにカスタムアプリケーションを作成し、AuthScheme をOAuthClient に設定します。次に、以下のプロパティを指定します。
- OAuthClientId:アプリケーションを登録した際に割り当てられたクライアントId。
- OAuthClientSecret:アプリケーションを登録した際に割り当てられたクライアントシークレット。
- ContractId:Smaregi アカウントに関連付けられた契約ID。
OAuth
認証するには、AuthScheme をOAuth に設定し、カスタムOAuth アプリケーションの作成 で説明されているようにカスタムアプリケーションを作成します。
以下のセクションでは、異なる環境からOAuth を使用して認証する方法について説明します。
デスクトップアプリケーション
デスクトップアプリケーション経由で接続するには、OAuth アクセストークンを設定し、リフレッシュする必要があります。OAuth アクセストークンの取得およびリフレッシュ
以下を設定して、接続してください。
- OAuthClientId:アプリケーションを登録した際に割り当てられたクライアントId。
- OAuthClientSecret:アプリケーションを登録した際に割り当てられたクライアントシークレット。
- CallbackURL:アプリケーションの登録時に定義されたCallback URL。デフォルトではhttp://localhost:33333 に設定されています。
接続すると、本製品 はデフォルトブラウザでSmaregi のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
アクセストークンの期限が切れたときは、本製品 は自動でアクセストークンをリフレッシュします。
OAuth アクセストークンの自動リフレッシュ
本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには:
- はじめてデータに接続する前に、次の接続プロパティを設定します。
- InitiateOAuth:REFRESH。
- OAuthClientId:アプリケーションを登録した際に割り当てられたクライアントId。
- OAuthClientSecret:アプリケーションを登録した際に割り当てられたクライアントシークレット。
- OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークン。
- OAuthRefreshToken:GetOAuthAccessToken によって返されたリフレッシュトークン。
- OAuthSettingsLocation:本製品 がOAuth 値を保存する場所のパス。これは接続間で維持されます。
- その後のデータ接続では、以下を設定します。
OAuth アクセストークンの手動リフレッシュ:
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
- ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
- 次の接続プロパティを設定します。
- OAuthClientId:アプリケーションを登録した際に割り当てられたクライアントId。
- OAuthClientSecret:アプリケーションを登録した際に割り当てられたクライアントシークレット。
- RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
- 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
接続プロパティ
最後に、Connection プロパティを参照してください。接続の確立に使用できるさまざまなオプションの説明があります。
接続の管理
Smaregi への認証に成功すると、インポートするデータをカスタマイズすることができます。詳しくは、接続の管理 を参照してください。
関連項目
- データのクエリ:[データ選択]ウィザードを使用してスプレッドシートにデータをプルします。また、ここではスケジュールされたデータのリフレッシュも設定できます。
- Excel アドインの使用:利用可能なCData Excel 関数 を使用するなど、Smaregi データとやり取りする他の方法が見つかります。