PHP のOData SDK を使用したSage Intacct のデータのクエリ

CData API Server は、ADO.NET Provider for SageIntacct（またはその他の250+ ADO.NET Providers のデータ）と組み合わせることでWeb サービスとしてSage Intacct のデータを公開します。下記の手順に従って、Sage Intacct のデータをオブジェクトとして使用します。

はじめに

---

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSage Intacct OData サービスを作成していきましょう。

Sage Intacct への接続

PHP からSage Intacct のデータを操作するには、まずSage Intacct への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Sage Intacct」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Sage Intacct への接続設定を行っていきましょう！

5. Sage Intacct 接続プロパティの取得・設定方法

   独自のWeb サービスクレデンシャル、埋め込みクレデンシャル（Basic 認証）、またはOkta クレデンシャルのいずれかを使用して、Sage Intacct への接続を確立できます。

   Sage Intacct への認証

   Sage Intacct は2種類の認証をサポートします。Basic およびOkta です。選択した認証方法に関連するプロパティを設定して、接続を構成します。

   Basic 認証

   Basic 認証スキームでは、埋め込みクレデンシャルを使用してデータの読み書きが可能です。オプションとして、独自のWeb サービスクレデンシャルを指定することもできます。

   Basic 認証を使用して認証を行うには、以下のプロパティを設定します。

   • AuthScheme：Basic。
   • CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
   • User：Sage Intacct へのログインに使用するログイン名。
   • Password：ログインクレデンシャル用のパスワード。
   • （オプション）SenderID およびSenderPassword：Web サービスのSender ID およびパスワード（独自のWeb サービスクレデンシャルを使用している場合のみ）。

   独自のWeb サービスクレデンシャルではなく、埋め込みクレデンシャルを使用する場合は、以下を実行する必要があります：

   • Web サービスダッシュボードで、会社 -> 会社情報 -> セキュリティタブに移動します。
   • Web サービス認証に"CData" を追加します。これは大文字・小文字が区別されます。これを行うには、会社 -> 会社情報（新しいUI では、設定 -> 会社）-> セキュリティ -> Web サービス認証 / 編集に移動します。
   Okta 認証についてはヘルプドキュメントを参照してください。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Sage Intacct 接続プロパティの取得・設定方法

独自のWeb サービスクレデンシャル、埋め込みクレデンシャル（Basic 認証）、またはOkta クレデンシャルのいずれかを使用して、Sage Intacct への接続を確立できます。

Sage Intacct への認証

Sage Intacct は2種類の認証をサポートします。Basic およびOkta です。選択した認証方法に関連するプロパティを設定して、接続を構成します。

Basic 認証

Basic 認証スキームでは、埋め込みクレデンシャルを使用してデータの読み書きが可能です。オプションとして、独自のWeb サービスクレデンシャルを指定することもできます。

Basic 認証を使用して認証を行うには、以下のプロパティを設定します。

• AuthScheme：Basic。
• CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
• User：Sage Intacct へのログインに使用するログイン名。
• Password：ログインクレデンシャル用のパスワード。
• （オプション）SenderID およびSenderPassword：Web サービスのSender ID およびパスワード（独自のWeb サービスクレデンシャルを使用している場合のみ）。

独自のWeb サービスクレデンシャルではなく、埋め込みクレデンシャルを使用する場合は、以下を実行する必要があります：

• Web サービスダッシュボードで、会社 -> 会社情報 -> セキュリティタブに移動します。
• Web サービス認証に"CData" を追加します。これは大文字・小文字が区別されます。これを行うには、会社 -> 会社情報（新しいUI では、設定 -> 会社）-> セキュリティ -> Web サービス認証 / 編集に移動します。

API Server のユーザー設定

次に、API Server 経由でSage Intacct にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Sage Intacct 用のAPI エンドポイントの作成

ユーザーを作成したら、Sage Intacct のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でSage Intacct への接続を設定してユーザーを作成し、API Server でSage Intacct データのAPI を追加しました。これで、OData 形式のSage Intacct データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Sage Intacct 接続プロパティの取得・設定方法

独自のWeb サービスクレデンシャル、埋め込みクレデンシャル（Basic 認証）、またはOkta クレデンシャルのいずれかを使用して、Sage Intacct への接続を確立できます。

Sage Intacct への認証

Sage Intacct は2種類の認証をサポートします。Basic およびOkta です。選択した認証方法に関連するプロパティを設定して、接続を構成します。

Basic 認証

Basic 認証スキームでは、埋め込みクレデンシャルを使用してデータの読み書きが可能です。オプションとして、独自のWeb サービスクレデンシャルを指定することもできます。

Basic 認証を使用して認証を行うには、以下のプロパティを設定します。

• AuthScheme：Basic。
• CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
• User：Sage Intacct へのログインに使用するログイン名。
• Password：ログインクレデンシャル用のパスワード。
• （オプション）SenderID およびSenderPassword：Web サービスのSender ID およびパスワード（独自のWeb サービスクレデンシャルを使用している場合のみ）。

独自のWeb サービスクレデンシャルではなく、埋め込みクレデンシャルを使用する場合は、以下を実行する必要があります：

• Web サービスダッシュボードで、会社 -> 会社情報 -> セキュリティタブに移動します。
• Web サービス認証に"CData" を追加します。これは大文字・小文字が区別されます。これを行うには、会社 -> 会社情報（新しいUI では、設定 -> 会社）-> セキュリティ -> Web サービス認証 / 編集に移動します。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

• Windows：C:\ProgramData\CData\SageIntacct\
• Unix or Mac OS X：~/cdata/SageIntacct/

Sage Intacct エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

1. 以下のようなコマンドにURL を渡します。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\SageIntacctEntities.php

   上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

   API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

   許可されたユーザーは、API Server の「Users」セクションで設定できます。

2. PHP のオブジェクト指向インターフェースを使用して、Sage Intacct のデータへのアクセスを開始できます。以下のコードは、Customer テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。

   require_once 'SageIntacctEntities.php';
   try{
     $svc = new CData();
     $customer = new Customer();
     $customer->CustomerId = '12345';
     $svc->AddToCustomer($customer);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->customer()->Execute();
     foreach($response->Result as $customer)
       echo $customer->Name."";
   } catch (Exception $e) {    //catch errors from the API Server
     echo $e->getError(), "\n";
   }