API の接頭辞 ​

API の接頭辞は、各 Workato アカウントに固有のベースパスであり、これを使用して API プラットフォームの環境を定義できます。たとえば、API の接頭辞を使用して、開発、テスト、本番のエンドポイントを区別できます。そうすることでコレクションパスを再利用できます。

会社全体でコレクション名を標準化すると、レシピのエクスポートプロセスが簡素化されます。たとえばチームは、コレクションパスの競合を気にせずに、レシピを開発アカウント (/acme-dev/sales-api/) から本番アカウント (/acme/sales-api/) に簡単にエクスポートできます。API の接頭辞によって、環境間をシームレスに連携することができます。

エンドポイントについて ​

Workato の各エンドポイントは、いくつかの部分で構成されています。これらのコンポーネントがまとまって、一意の API エンドポイントを形成します。

エンドポイントのコンポーネント

設定 ​

左側のメニューで [Tools] > [API Platform] > [Settings] タブ > [API path prefix] に移動します。

API の接頭辞のカスタマイズ

この API の接頭辞は、このアカウント (個人またはチーム) 内のすべての API コレクションとエンドポイントに適用されます。デフォルトの API の接頭辞は、アカウントプロファイル名のイニシャルに設定されます。

古い API コレクションの API の接頭辞 ​

新しく作成されるすべての Workato API コレクションには、API の接頭辞が事前に設定されますが、この処理が古い API コレクションには適用されません。古い API コレクションは、アップグレードされるまで既存の URL を維持します。

API コレクションをアップグレードする理由 ​

アップグレードすると、API コレクションに対して直ちに API の接頭辞が有効になります。また、レシピのエクスポート/インポートが簡素化されるメリットもあります。さらにカスタムドメインの設定も可能になるため、独自のサブドメイン下で API エンドポイントを公開できるようになります。API プラットフォームの今後のアップグレードは、このバージョンの API コレクションをベースに行われます。新しい機能の恩恵を受けるには、この API コレクションをアップグレードしてください。

API コレクションをアップグレードする方法 ​

たとえば、以下の API コレクションで API の接頭辞が有効化されていないとします。この API コレクションをアップグレードするプロセスを簡単に説明します。

API の接頭辞のない API コレクション

ステップ	説明
1.	API コレクションの [Settings] タブに移動します。 API コレクションの設定
2.	[Start upgrade] を選択します。
3.	アップグレードに関する注意事項を読み、準備ができたら [Start upgrade] を選択します。 API コレクションのアップグレード
4.	アップグレードが完了し、この API コレクションのすべてのエンドポイントで API の接頭辞が有効になります。 API の接頭辞が有効

次に、この API コレクションの既存のユーザーに変更について通知します (まだ通知していない場合)。