PHP のOData SDK を使用したSAP Ariba Procurement のデータのクエリ
CData API Server は、ADO.NET Provider for SAPAribaProcurement（またはその他の240+ ADO.NET Providers のデータ）と組み合わせることで、SAP Ariba Procurement のデータをWeb サービスとして公開します。下記の手順に従って、SAP Ariba Procurement のデータをPHP オブジェクトとして使用しましょう。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSAP Ariba Procurement OData サービスを作成していきましょう。
SAP Ariba Procurement への接続
PHP からSAP Ariba Procurement のデータを操作するには、まずSAP Ariba Procurement への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SAP Ariba Procurement」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、SAP Ariba Procurement への接続設定を行っていきましょう！
-
それでは、SAP Ariba Procurement に接続していきましょう。接続するには、以下のプロパティを設定します。
- ANID：Ariba Network ID
- API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Buyer またはSupplier API を選択します（可能な値は、PurchaseOrdersBuyerAPIV1、または PurchaseOrdersSupplierAPIV1 です）
- Environment：接続先がテスト環境か本番環境かを指定してください（可能な値は、TEST またはPRODUCTION です）
OAuth 認証
続いて、接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。
- AuthScheme をOAuthClient に設定します
- サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります
OAuth アプリケーションの作成について、詳しくはヘルプドキュメントをご確認ください。
OAuth の自動リフレッシュ
以下のプロパティを設定して、接続してみましょう。
- APIKey：アプリケーション設定のApplication key
- OAuthClientId：アプリケーション設定のOAuth Client Id
- OAuthClientSecret：アプリケーション設定のOAuth Secret
接続すると、CData 製品が自動でOAuth プロセスを完了します。
- CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
- CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
- OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
それでは、SAP Ariba Procurement に接続していきましょう。接続するには、以下のプロパティを設定します。
- ANID：Ariba Network ID
- API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Buyer またはSupplier API を選択します（可能な値は、PurchaseOrdersBuyerAPIV1、または PurchaseOrdersSupplierAPIV1 です）
- Environment：接続先がテスト環境か本番環境かを指定してください（可能な値は、TEST またはPRODUCTION です）
OAuth 認証
続いて、接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。
- AuthScheme をOAuthClient に設定します
- サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります
OAuth アプリケーションの作成について、詳しくはヘルプドキュメントをご確認ください。
OAuth の自動リフレッシュ
以下のプロパティを設定して、接続してみましょう。
- APIKey：アプリケーション設定のApplication key
- OAuthClientId：アプリケーション設定のOAuth Client Id
- OAuthClientSecret：アプリケーション設定のOAuth Secret
接続すると、CData 製品が自動でOAuth プロセスを完了します。
- CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
- CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
- OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます
API Server のユーザー設定
次に、API Server 経由でSAP Ariba Procurement にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
SAP Ariba Procurement 用のAPI エンドポイントの作成
ユーザーを作成したら、SAP Ariba Procurement のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でSAP Ariba Procurement への接続を設定してユーザーを作成し、API Server でSAP Ariba Procurement データのAPI を追加しました。これで、OData 形式のSAP Ariba Procurement データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
それでは、SAP Ariba Procurement に接続していきましょう。接続するには、以下のプロパティを設定します。
- ANID：Ariba Network ID
- API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Buyer またはSupplier API を選択します（可能な値は、PurchaseOrdersBuyerAPIV1、または PurchaseOrdersSupplierAPIV1 です）
- Environment：接続先がテスト環境か本番環境かを指定してください（可能な値は、TEST またはPRODUCTION です）
OAuth 認証
続いて、接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。
- AuthScheme をOAuthClient に設定します
- サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります
OAuth アプリケーションの作成について、詳しくはヘルプドキュメントをご確認ください。
OAuth の自動リフレッシュ
以下のプロパティを設定して、接続してみましょう。
- APIKey：アプリケーション設定のApplication key
- OAuthClientId：アプリケーション設定のOAuth Client Id
- OAuthClientSecret：アプリケーション設定のOAuth Secret
接続すると、CData 製品が自動でOAuth プロセスを完了します。
- CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
- CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
- OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます
さらに、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\SAPAribaProcurement\
- Unix or Mac OS X：~/cdata/SAPAribaProcurement/
SAP Ariba Procurement エンティティを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\SAPAribaProcurementEntities.php
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。
API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。
許可されたユーザーは、API Server の「Users」セクションで設定できます。
-
PHP のオブジェクト指向インターフェースを使用して、SAP Ariba Procurement のデータへのアクセスを開始できます。以下のコードは、Orders テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。
require_once 'SAPAribaProcurementEntities.php'; try{ $svc = new CData(); $orders = new Orders(); $orders->OrderStatus = 'CHANGED'; $svc->AddToOrders($orders); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->orders()->Execute(); foreach($response->Result as $orders) echo $orders->DocumentNumber.""; } catch (Exception $e) { //catch errors from the API Server echo $e->getError(), "\n"; }