ドキュメントの検索
karat

+

K

APIリファレンス ↗

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

REST

Foundry は REST(representational state transfer)API を公開する外部システムと統合できます。同期、エクスポート、または REST API を対話的に呼び出すかどうかにより、異なるアプローチを使用する必要があるかもしれません。このページでは、REST API との安全で効率的な統合のためのいくつかの接続オプションを見つけることができます。

REST API ソース

REST API ソースは、Foundry アプリケーションから直接外部システムへの対話的な HTTP リクエストが必要なワークフローに使用できます。たとえば、ボタンを使用した Workshop アプリケーションを作成し、そのボタンがクリックされると Webhook を使用して REST エンドポイントを呼び出し、そのアプリケーションを既存のワークフローとソースシステムに接続することができます。

HTTP エンドポイントへの Webhook は、Data Connection の REST API ソースタイプを使用する必要があります。ベース URL、認証、およびオプションのポートを設定する必要があります。

オプション必須説明
ドメインはい少なくとも1つのドメインを指定する必要があります。
認証はい各ドメインに対して、認証を指定する必要があります。オプションには、NoneBasicBearer Token、および API Key があります。
ポートいいえポートはオプションで指定できます。デフォルトでは、すべての REST Webhook はポート 443 上の HTTPS を使用します。443 以外のポートは、エージェントランタイムを使用している場合のみサポートされています。
リクエストオプションいいえAPI Key 認証を選択するとき、API Key をクエリパラメータまたは Webhook リクエストのヘッダーとして渡すかどうかを選択できます。

以下の例の設定は、bearer トークン認証を使用して https://my-domain.com への接続を設定する方法を示しています。

New webhook

REST API ソースタイプは、他の機能(同期やエクスポートなど)をサポートしていません。レガシーの magritte-rest-v2 ソースタイプは、Webhook ワークフローにはもはや推奨されていません。REST API への同期とエクスポートは、外部トランスフォームを使用する必要があります。

Foundry での Webhook について詳しく学ぶ

コードリポジトリの外部トランスフォーム

Python トランスフォームリポジトリを使用して、ネットワークの出口と資格情報を設定し、API にアクセスするロジックを記述します。たとえば、外部トランスフォームを使用して API をクエリし、Foundry データセットのメタデータを処理するか、API サービスと対話して画像をデータセットに出力することができます。外部トランスフォームは、REST API を呼び出す必要がある同期とエクスポートを設定する推奨の方法です。

現在、外部トランスフォームは、オンプレミスシステムと通信するためのエージェントランタイムをサポートしていません。レガシーの magritte-rest-v2 ソースタイプは、オンプレミスの REST API コールに使用できますが、直接接続にはもはや推奨されていません。ファイアウォールの背後にある REST API を呼び出す必要がある場合は、詳細については Palantir の担当者に問い合わせてください。

外部トランスフォームで API を呼び出す方法について詳しく学ぶ

Foundry REST API

Foundry プラットフォームの上にアプリケーションを構築したい場合、Foundry REST API を使用します。Foundry API は OAuth 2.0 プロトコルを認証に使用し、主に JSON リクエストとレスポンスを使用し、オントロジーとモデリングリソースのサポートを提供します。

Foundry API について詳しく学ぶ