PHP のOData SDK を使用したMYOB AccountRight のデータのクエリ
CData API Server は、ADO.NET Provider for MYOB(またはその他の250+ ADO.NET Providers のデータ)と組み合わせることでWeb サービスとしてMYOB AccountRight のデータを公開します。下記の手順に従って、MYOB AccountRight のデータをオブジェクトとして使用します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなMYOB AccountRight OData サービスを作成していきましょう。
MYOB AccountRight への接続
PHP からMYOB AccountRight のデータを操作するには、まずMYOB AccountRight への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「MYOB AccountRight」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、MYOB AccountRight への接続設定を行っていきましょう!
-
MYOB への接続
MYOB 会社ファイルに接続するには、CompanyFileId をデータを取得したい会社ファイルのID に設定します。指定しない場合は、最初に返された会社ファイルのID(アルファベット順にソート)が使用されます。
この接続プロパティは、CompanyFiles ビューを除くすべてのテーブルおよびビューにアクセスするために必要です。CompanyFiles ビューは、アカウントに紐づく会社ファイル(およびその関連ID)を表示するために使用できます。会社ファイルのID がわからない場合は、このビューを使用してください。
次のプロパティを追加設定します。
オンプレミスインスタンス Instance:OnPremises AuthScheme:Basic User:会社のファイルに紐づいているユーザー名。会社ファイルを作成すると、Administrator というユーザーアカウントが自動的に作成されます。デフォルトでは、Administrator ユーザーアカウントにはパスワードが割り当てられません。 InitiateOAuth:OFF。 URL:MYOB インスタンスのURL。 クラウドインスタンス Instance:Cloud AuthScheme:OAuth InitiateOAuth:GETANDREFRESH。 User:会社のファイルに紐づいているユーザー名。 Password:(パスワードが設定されている場合)会社ファイルの認可されたユーザーのパスワード OAuth で認証する場合は、さらにヘルプドキュメントを参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
MYOB への接続
MYOB 会社ファイルに接続するには、CompanyFileId をデータを取得したい会社ファイルのID に設定します。指定しない場合は、最初に返された会社ファイルのID(アルファベット順にソート)が使用されます。
この接続プロパティは、CompanyFiles ビューを除くすべてのテーブルおよびビューにアクセスするために必要です。CompanyFiles ビューは、アカウントに紐づく会社ファイル(およびその関連ID)を表示するために使用できます。会社ファイルのID がわからない場合は、このビューを使用してください。
次のプロパティを追加設定します。
| オンプレミスインスタンス | Instance:OnPremises |
| AuthScheme:Basic | |
| User:会社のファイルに紐づいているユーザー名。会社ファイルを作成すると、Administrator というユーザーアカウントが自動的に作成されます。デフォルトでは、Administrator ユーザーアカウントにはパスワードが割り当てられません。 | |
| InitiateOAuth:OFF。 | |
| URL:MYOB インスタンスのURL。 | |
| クラウドインスタンス | Instance:Cloud |
| AuthScheme:OAuth | |
| InitiateOAuth:GETANDREFRESH。 | |
| User:会社のファイルに紐づいているユーザー名。 | |
| Password:(パスワードが設定されている場合)会社ファイルの認可されたユーザーのパスワード |
OAuth で認証する場合は、さらにヘルプドキュメントを参照してください。
API Server のユーザー設定
次に、API Server 経由でMYOB AccountRight にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
MYOB AccountRight 用のAPI エンドポイントの作成
ユーザーを作成したら、MYOB AccountRight のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でMYOB AccountRight への接続を設定してユーザーを作成し、API Server でMYOB AccountRight データのAPI を追加しました。これで、OData 形式のMYOB AccountRight データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
MYOB への接続
MYOB 会社ファイルに接続するには、CompanyFileId をデータを取得したい会社ファイルのID に設定します。指定しない場合は、最初に返された会社ファイルのID(アルファベット順にソート)が使用されます。
この接続プロパティは、CompanyFiles ビューを除くすべてのテーブルおよびビューにアクセスするために必要です。CompanyFiles ビューは、アカウントに紐づく会社ファイル(およびその関連ID)を表示するために使用できます。会社ファイルのID がわからない場合は、このビューを使用してください。
次のプロパティを追加設定します。
| オンプレミスインスタンス | Instance:OnPremises |
| AuthScheme:Basic | |
| User:会社のファイルに紐づいているユーザー名。会社ファイルを作成すると、Administrator というユーザーアカウントが自動的に作成されます。デフォルトでは、Administrator ユーザーアカウントにはパスワードが割り当てられません。 | |
| InitiateOAuth:OFF。 | |
| URL:MYOB インスタンスのURL。 | |
| クラウドインスタンス | Instance:Cloud |
| AuthScheme:OAuth | |
| InitiateOAuth:GETANDREFRESH。 | |
| User:会社のファイルに紐づいているユーザー名。 | |
| Password:(パスワードが設定されている場合)会社ファイルの認可されたユーザーのパスワード |
OAuth で認証する場合は、さらにヘルプドキュメントを参照してください。
さらに、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\MYOB\
- Unix or Mac OS X:~/cdata/MYOB/
MYOB AccountRight エンティティをPHP オブジェクトとして使用する
以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。
-
以下のようなコマンドにURL を渡します。
php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\MYOBEntities.php
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。
API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。
許可されたユーザーは、API Server の「Users」セクションで設定できます。
-
PHP のオブジェクト指向インターフェースを使用して、MYOB AccountRight のデータへのアクセスを開始できます。以下のコードは、Accounts テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。
require_once 'MYOBEntities.php'; try{ $svc = new CData(); $accounts = new Accounts(); $accounts->Type = 'Bank'; $svc->AddToAccounts($accounts); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->accounts()->Execute(); foreach($response->Result as $accounts) echo $accounts->Id.""; } catch (Exception $e) { //catch errors from the API Server echo $e->getError(), "\n"; }