API の接頭辞
API の接頭辞は、各 Workato アカウントに固有のベースパスであり、これを使用して API プラットフォームの環境を定義できます。たとえば、API の接頭辞を使用して、開発、テスト、本番のエンドポイントを区別できます。そうすることでコレクションパスを再利用できます。
会社全体でコレクション名を標準化すると、レシピのエクスポートプロセスが簡素化されます。たとえばチームは、コレクションパスの競合を気にせずに、レシピを開発アカウント (/acme-dev/sales-api/) から本番アカウント (/acme/sales-api/) に簡単にエクスポートできます。API の接頭辞によって、環境間をシームレスに連携することができます。
WARNING
oauth2 は予約済みの名前空間です。パスの接頭辞 oauth2/* は利用できません。
エンドポイントについて
Workato の各エンドポイントは、いくつかの部分で構成されています。これらのコンポーネントがまとまって、一意の API エンドポイントを形成します。
エンドポイントのコンポーネント
| コンポーネント | 説明 |
|---|---|
| ドメインとサブドメイン | デフォルトでは、Workato API は apim.workato.com から呼び出されます。ドメイン名は、カスタムドメインの設定を使用してカスタマイズできます。 |
| API の接頭辞 | API の接頭辞は、API プラットフォームの環境を定義するために使用される上位レベルのディレクトリパスです。 |
| コレクションパス | コレクションは、いくつかの共通したアクセスパターンを持つエンドポイントの論理グループです。詳細については、「API コレクション」を参照してください。 |
| エンドポイントパス | エンドポイントパスは、エンドポイントの概要から設定できます。 |
設定
左側のメニューで [Platform] > [API Platform] > [Settings] タブ > [API path prefix] に移動します。
API の接頭辞のカスタマイズ
この API の接頭辞は、このアカウント (個人またはチーム) 内のすべての API コレクションとエンドポイントに適用されます。デフォルトの API の接頭辞は、アカウントプロファイル名のイニシャルに設定されます。
WARNING
API の接頭辞を変更するには、API の既存のクライアントが自身の側で調整を行う必要があります。
Last updated: