APIが有効になったら、OData構文を使ってそれを呼び出すことができます。
一般構文
APIを呼び出すためには、次の情報が必要です:
- APIのURL。ベースURLとAPIを有効化する時に生成されたAPIパスで構成されています。Cloud Engine for Designをお使いの場合は、このURLはデータセットのAPIタブ内に表示されます。Remote Engine Gen2をお使いの場合は、APIパスのみが表示されます。管理者に連絡して、ベースURLを取得します。
- ベースURLとAPIパスの間に
/apis/を挿入する場合。APIコールのURLテンプレートは、<base_url>/apis/<api_path>のようになります。 - 使いたいコンシューマーを作成する時に定義された認証情報。
Cloud Engine for DesignでAPIをコールする場合は、次の制限事項を考慮する必要があります。
- コールレートは着信クライアントIPごとにつき1秒間に30リクエストに制限されています。
- 同じVPNネットワークにあるマシンは、同じパブリックIPを共有しているため、1つのクライアントIPとしてカウントされます。
警告: 一時的な問題により、ソースデータセットで特定のセマンティックタイプを使用するカラムがAPI経由で呼び出された場合に、
{string} (文字列)セマンティックタイプに変換されてしまうことがありました:boolean値dates(日付と時間も含まれる)- Oracleの場合、
integerと10進数の値 - 長
{integer} (整数)値(SQLbigint)
パーソナル環境でテスト
ここでは、お使いのパーソナルマシンにインストールされたRemote Engine Gen2でホストされている接続で作成された基本的な顧客情報を持つデータセットの例を見てみましょう。customersエンティティセットとcustomers-api-2PZPTBAPIパスでAPIを有効化すると、次のURLを使ってお好みのツールで呼び出すことができます:
http://localhost:8080/apis/customers-api-2PZPTB/customersパーソナルマシンでお使いのAPIがホストされているため、ベースURLは単純にhttp://localhost:8080となります。このリクエストはデータセット全体の詳細を返します。
本番環境でAPIを呼び出す例
同じAPIを呼び出そうとしても、本番環境コンテキストでの場合は、一部のパラメーターが変更され次のURLとなります:
https://mycompany.com/apis/customers-api-2PZPTB/customers- APIはHTTPSで保護されるようになります。HTTPSの設定方法に関する情報は、APIを保護をご覧ください。
- ベースURLは、会社のドメインや他のいずれかのカスタム形式を反映するよう、管理者によって設定されています。
URLの残りの部分(つまり/apis/とAPIパス)は同一のままとなります。
サポートされているOData式を使った呼び出しの他の例は、API式をご覧ください。