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