PHP のOData SDK を使用したSAP Ariba Source のデータのクエリ

加藤龍彦
デジタルマーケティング

API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でSAP Ariba Source エンティティを手軽に使用。

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

API Server の設定

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

SAP Ariba Source への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SAP Ariba Source」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、SAP Ariba Source への接続設定を行っていきましょう！
それでは、SAP Ariba Source に接続していきましょう。接続するには、以下のプロパティを設定します。
- API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します（可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です）
- DataCenter：アカウントのデータがホストされているデータセンター
- Realm：アクセスしたいサイト名
- Environment：テスト環境、または本番環境のいずれかを指定してください。（可能な値は、TEST またはPRODUCTION）
Supplier Data API またはContract API に接続する場合は、さらに以下のプロパティも設定してください。
- User：API 呼び出しを行うユーザーのId
- PasswordAdapter：認証するUser に関連付けられたパスワード
Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定してください。

OAuth 認証

続いて、接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。
- AuthScheme をOAuthClient に設定します
- サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります
OAuth アプリケーションの作成について、詳しくはヘルプドキュメントをご確認ください。

OAuth の自動リフレッシュ

以下のプロパティを設定して、接続してみましょう。
- APIKey：アプリケーション設定のApplication key
- OAuthClientId：アプリケーション設定のOAuth Client Id
- OAuthClientSecret：アプリケーション設定のOAuth Secret
接続すると、CData 製品が自動でOAuth プロセスを完了します。
1. CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
2. CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
3. OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

それでは、SAP Ariba Source に接続していきましょう。接続するには、以下のプロパティを設定します。

API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します（可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です）
DataCenter：アカウントのデータがホストされているデータセンター
Realm：アクセスしたいサイト名
Environment：テスト環境、または本番環境のいずれかを指定してください。（可能な値は、TEST またはPRODUCTION）

Supplier Data API またはContract API に接続する場合は、さらに以下のプロパティも設定してください。

User：API 呼び出しを行うユーザーのId
PasswordAdapter：認証するUser に関連付けられたパスワード

Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定してください。

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 Source にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

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

SAP Ariba Source 用のAPI エンドポイントの作成

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

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

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

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

それでは、SAP Ariba Source に接続していきましょう。接続するには、以下のプロパティを設定します。

API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します（可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です）
DataCenter：アカウントのデータがホストされているデータセンター
Realm：アクセスしたいサイト名
Environment：テスト環境、または本番環境のいずれかを指定してください。（可能な値は、TEST またはPRODUCTION）

Supplier Data API またはContract API に接続する場合は、さらに以下のプロパティも設定してください。

User：API 呼び出しを行うユーザーのId
PasswordAdapter：認証するUser に関連付けられたパスワード

Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定してください。

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\SAPAribaSource\
Unix or Mac OS X：~/cdata/SAPAribaSource/

SAP Ariba Source エンティティを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\SAPAribaSourceEntities.php
```
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

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

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

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

require_once 'SAPAribaSourceEntities.php';
try{
  $svc = new CData();
  $vendors = new Vendors();
  $vendors->Region = 'USA';
  $svc->AddToVendors($vendors);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->vendors()->Execute();
  foreach($response->Result as $vendors)
    echo $vendors->SMVendorID."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

CData は、AI を本番環境で機能させるデータレイヤーです。350 以上のソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ

PHP のOData SDK を使用したSAP Ariba Source のデータのクエリ

API Server の設定

SAP Ariba Source への接続

OAuth 認証

OAuth の自動リフレッシュ

OAuth 認証

OAuth の自動リフレッシュ

API Server のユーザー設定

SAP Ariba Source 用のAPI エンドポイントの作成

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

OAuth 認証

OAuth の自動リフレッシュ

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

SAP Ariba Source エンティティをPHP オブジェクトとして使用する

はじめる準備はできましたか？

この記事の内容

関連記事