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

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でAnaplan エンティティを手軽に使用。



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

API Server の設定

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

Anaplan への接続

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

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

  5. Anaplan への認証

    ドライバーはBasic、証明書、またはOAuth による認証をサポートしています。いずれの場合も、Region をAnaplan アカウントデータがホストされているリージョン（例：US1、これがデフォルト）に設定してください。

    Basic 認証の使用

    AuthScheme をBasic に設定し、Anaplan のUser とPassword を入力します。ワークスペースがシングルサインオン（SSO）を使用している場合は、Basic 認証を使用するために Exception User として割り当てられている必要があります。

    証明書認証の使用

    AuthScheme をCertificate に設定し、Certificate、CertificateType、PrivateKey プロパティを入力します（どちらかが暗号化されている場合はCertificatePassword / PrivateKeyPassword も設定してください）。証明書は、Anaplan テナント管理者に登録されたCA 発行のX.509 証明書である必要があります。

    OAuth 認証の使用

    Anaplan でカスタムOAuth アプリケーションを登録し、以下のプロパティを設定します：

    • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
    • CallbackURL：アプリケーションの登録時に定義したリダイレクトURI。
    • InitiateOAuth：GETANDREFRESH に設定すると、ドライバーがOAuth トークンの交換と更新を自動的に管理します。

    カスタムOAuth アプリの作成方法とOAuth の使用方法については、ヘルプドキュメントの「はじめに」の章を参照してください。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Anaplan への認証

ドライバーはBasic、証明書、またはOAuth による認証をサポートしています。いずれの場合も、Region をAnaplan アカウントデータがホストされているリージョン（例：US1、これがデフォルト）に設定してください。

Basic 認証の使用

AuthScheme をBasic に設定し、Anaplan のUser とPassword を入力します。ワークスペースがシングルサインオン（SSO）を使用している場合は、Basic 認証を使用するために Exception User として割り当てられている必要があります。

証明書認証の使用

AuthScheme をCertificate に設定し、Certificate、CertificateType、PrivateKey プロパティを入力します（どちらかが暗号化されている場合はCertificatePassword / PrivateKeyPassword も設定してください）。証明書は、Anaplan テナント管理者に登録されたCA 発行のX.509 証明書である必要があります。

OAuth 認証の使用

Anaplan でカスタムOAuth アプリケーションを登録し、以下のプロパティを設定します：

  • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
  • CallbackURL：アプリケーションの登録時に定義したリダイレクトURI。
  • InitiateOAuth：GETANDREFRESH に設定すると、ドライバーがOAuth トークンの交換と更新を自動的に管理します。

カスタムOAuth アプリの作成方法とOAuth の使用方法については、ヘルプドキュメントの「はじめに」の章を参照してください。

API Server のユーザー設定

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

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

Anaplan 用のAPI エンドポイントの作成

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

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

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

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

Anaplan への認証

ドライバーはBasic、証明書、またはOAuth による認証をサポートしています。いずれの場合も、Region をAnaplan アカウントデータがホストされているリージョン（例：US1、これがデフォルト）に設定してください。

Basic 認証の使用

AuthScheme をBasic に設定し、Anaplan のUser とPassword を入力します。ワークスペースがシングルサインオン（SSO）を使用している場合は、Basic 認証を使用するために Exception User として割り当てられている必要があります。

証明書認証の使用

AuthScheme をCertificate に設定し、Certificate、CertificateType、PrivateKey プロパティを入力します（どちらかが暗号化されている場合はCertificatePassword / PrivateKeyPassword も設定してください）。証明書は、Anaplan テナント管理者に登録されたCA 発行のX.509 証明書である必要があります。

OAuth 認証の使用

Anaplan でカスタムOAuth アプリケーションを登録し、以下のプロパティを設定します：

  • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
  • CallbackURL：アプリケーションの登録時に定義したリダイレクトURI。
  • InitiateOAuth：GETANDREFRESH に設定すると、ドライバーがOAuth トークンの交換と更新を自動的に管理します。

カスタムOAuth アプリの作成方法と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\Anaplan\
  • Unix or Mac OS X：~/cdata/Anaplan/

Anaplan エンティティを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\AnaplanEntities.php

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

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

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

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

    require_once 'AnaplanEntities.php';
try{
  $svc = new CData();
  $sales = new Sales();
  $sales->Value = '100';
  $svc->AddToSales($sales);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->sales()->Execute();
  foreach($response->Result as $sales)
    echo $sales->Region."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server

この記事の内容

関連記事