OData SDK for PHP を使ってJira Assets のデータを取得

CData Connect Server を使えば、OData を使ってJira Assets のデータにアクセスできます。CData Connect Server とOData PHP SDK を利用することで、Jira Assets のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

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

最終更新日:2022-11-25

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Connect Server はJira Assets のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Jira Assets のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect Server はJira Assets のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からJira Assets のデータへのリアルタイム連携を実現します。

Jira Assets の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

  1. CData Connect Server にログインして、「DATA MODEL」をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"Jira Assets" を選択します。
  3. Jira Assets に接続するために必要なプロパティを入力します。

    Jira Assets は、APIToken 経由での接続と認証をサポートしています。

    API トークンを生成するには:

    1. Atlassian アカウントにログインします。
    2. セキュリティ設定 > API トークン > API トークンを作成するをクリックします。

    Atlassian がAPI トークンを生成して表示します。

    API トークンを生成したら、以下のパラメータをセットします。

    • AuthScheme:APIToken。
    • User:認証するユーザーのログイン名。
    • APIToken:生成したAPI トークン。

    これでJira Assets に接続して認証する準備が整いました。

    接続を設定
  4. 「Test Connection」をクリックします。
  5. 「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
  6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

コネクションとOData エンドポイントを設定したら、PHP からJira Assets のデータに接続できます。

  1. まずは、ODataPHP SDK を使用してCData Connect Server が公開したWeb サービスに接続するプロキシクラスを作成します。

    URI 部分を書き換えて、次のようなコマンドを実行してください。

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

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

    CData Connect Server およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect Server はOData エンドポイントへのアクセスが認可されたユーザーの認証に、認証トークンを使用します。認証トークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

    認証済みのユーザーは、CData Connect Server の管理コンソールのUsers セクションで設定できます。

  2. これで、PHP のオブジェクト指向インターフェースを使ってJira Assets のデータにアクセスできます。以下のコードはObjects テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

    require_once 'JiraAssetsEntities.php'; try{ $svc = new CDataAPI(); $objects = new Objects(); $objects->Label = 'SYD-1'; $svc->AddToObjects($objects); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->objects()->Execute(); foreach($response->Result as $objects) echo $objects->ID."
    "; } catch (Exception $e) { //CData Connect Server からのエラーをキャッチ echo $e->getError(), "\n"; }

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。