Search

データ接続と設定

Version 25.3.9411

データ接続と設定

CData API Server をデプロイしたら、API Server 管理コンソールから以下の基本的な手順を実行する必要があります：

  1. データストアに接続する。

  2. API を構築する。

  3. API を設定する。

  4. API をクエリする。

データストアに接続する

API Server はリレーショナルデータベース、ファイルストア、他のAPI などのバックエンドサービスへの接続をサポートします。任意のJDBC ドライバーまたはプロバイダーは、基底のデータソースへのコネクティビティを提供できます。ただし、API Server には、すでにインストール済みの一般的なドライバーとプロバイダーが付属しています。

以下のタスクを含む接続に関する詳細情報は、接続ページ で確認できます：

API を構築する

データソースへの接続を定義したら、API で使用するテーブル（リソース）とストアドプロシージャ（関数）を追加する必要があります。詳細な手順については、API ページの次のトピックを参照してください：

また、データベースからテーブルを再生成せずに、テーブルのスキーマを変更することもできます。

スキーマを編集するには、テーブルエントリの編集ボタンをクリックします。作成されたスキーマは、3つの必要不可欠な要素を含みます：

  • リソースカラムの定義を含む情報ブロック

  • データ接続

  • HTTP メソッドに対応し、データ処理オペレーションを呼び出すメソッド

さらに、リソースの名前を変更したり、カラムのデータ型を変更したりすることで、スキーマをカスタマイズすることができます。このような変更を行うための詳細な手順については、一般的なカスタマイズを参照してください。

API を設定する

API のテーブルとストアドプロシージャを作成したら、次のセクションの手順を実行して、許可されたユーザーとIP アドレス（デフォルトではすべてのIP アドレスが許可されています）にこれらのテーブルとストアドプロシージャを公開します。

アクセス制御の設定

次のように、Web インターフェースを介してAPI へのアクセスを管理します：

  1. API Server 管理コンソールで設定 > 信用されたIP アドレスを選択し、API Server へのアクセスを許可するIP アドレスを定義します。

  2. ブラウザベースのクライアントから接続する場合は、クロスオリジンリソース共有を設定する必要があります。これを行うには、管理コンソールで設定 > クロスオリジンリソース共有（CORS）を選択します。

  3. ナビゲーションペインでユーザーを選択して、ユーザーおよび対応する認証トークンを作成します。

API への認証

サーバーをデプロイしてAPI ユーザーを作成したら、API リクエストに認証トークン認証 を指定できます。

API をクエリする

幅広くサポートされているツールから標準のREST API に接続したり、プレーンなJavaScript を介してJSON API とやり取りしたりできます。

標準ドライバー経由で接続

CData drivers for API Server を使用して、ビジネスインテリジェンス（BI）、アナリティクス、ETL、およびその他のSQL ベースのツールから、リモートデータベースとしてAPI に接続します。.NET、Java、PHP、Objective-C などのネイティブプラットフォームから接続することもできます。API ドライバーに関する詳細は、API ドライバー製品ドキュメントを参照してください。

OData 経由で接続

OData プロトコルは開発者ツールによって広くサポートされており、.NET、Java、PHP、Objective-C、その他のプラットフォームからOData を操作するためのクライアントライブラリが多数提供されています。OpenAPI に基づいて、API は完全にドキュメント化され検出可能です。アプリケーション、ドキュメンテーションジェネレータ、クライアントサイドライブラリなどへのメタデータURL 情報については、検出を参照してください。

CData Software ナレッジベースでは、これらやその他の一般的なOData API コンシューマ（例えば、Salesforce Lightning Connect、SharePoint 外部リスト、Microsoft Power BI、Excel など）に関するクイックスタート記事を見つけることができます。

以下は、デフォルトの形式であるJSON 形式のOData でのクエリとレスポンスの例です。

リクエスト

http://localhost:8080/api.rsc/Cars

レスポンス

{
  "@odata.context":"http://MyServer:MyPort/api.rsc/$metadata#Cars",
  "value":[
    { "Id": "10001", "Model": "MyModel1", "Color": "MyColor1" },
    { "Id": "10002", "Model2": "MyModel2", "Color2": "MyColor2" },
  ]
}

詳細情報

API を使い始めるには、次のセクションを参照してください：