APIプレフィックス
APIプレフィックスは、各Workatoアカウントに固有のベースパスです。 これを使用して、API platform Environmentを定義できます。 たとえば、APIプレフィックスを使用して、Development、テスト、およびプロダクションのエンドポイントを区別できます。 これにより、コレクションパスを再利用できます。
会社全体でコレクション名を標準化すると、レシピのエクスポートプロセスが簡素化されます。 たとえば、チームはコレクションパスの競合を心配することなく、Developmentアカウント（/acme-dev/sales-api/）からプロダクションアカウント/acme/sales-api/にレシピを簡単にエクスポートできます。 APIプレフィックスにより、Environment間でシームレスに作業できます。
WARNING
oauth2は予約済みの名前空間です。 パスプレフィックスoauth2/*は許可されていません。
エンドポイントについて
すべてのWorkatoエンドポイントは複数の部分で構成されています。 これらのコンポーネントが組み合わさって、一意のAPIエンドポイントを形成します。
エンドポイントのコンポーネント
| コンポーネント | 説明 |
|---|---|
| ドメインとサブドメイン | デフォルトでは、Workato APIはapim.workato.comから呼び出されます。 カスタムドメイン設定を使用してドメイン名をカスタマイズできます。 |
| APIプレフィックス | APIプレフィックスは、API platform Environmentを定義するために使用される上位レベルのディレクトリパスです。 |
| コレクションパス | コレクションは、アクセスパターンにいくつかの共通機能があるエンドポイントの論理グループです。詳細については、APIコレクションを参照してください。 |
| エンドポイントパス | エンドポイントパスは、エンドポイントの概要から設定できます。 |
設定
VIRTUAL PRIVATE WORKATO (VPW)のお客様
この機能を使用するには、お使いのVirtual Private Workato（VPW）インスタンスに固有の設定手順が必要です。 VPWをご利用のお客様は、インスタンスの設定詳細について、VPWのプライベートドキュメントを参照してください。
プラットフォーム＞API platform＞Settings＞API path prefixに移動します。
APIプレフィックスのカスタマイズ
このAPIプレフィックスは、このアカウント（個人またはチーム）のすべてのAPIコレクションとエンドポイントに適用されます。 デフォルトのAPIプレフィックスは、アカウントプロファイル名のイニシャルに設定されます。
WARNING
APIプレフィックスを変更すると、既存のAPIクライアント側で調整が必要になります。
古いAPIコレクションのAPIプレフィックス
新しく作成されたすべてのWorkato APIコレクションには、APIプレフィックスが事前設定されています。 ただし、これは古いAPIコレクションには適用されません。 これらは、アップグレードするまで既存のURLを保持します。
APIコレクションをアップグレードする理由
このアップグレードにより、このAPIコレクションのAPIプレフィックスが即座に有効になります。 これには、効率化されたレシピのエクスポート/インポートのメリットが含まれます。 また、カスタムドメイン設定も有効になり、独自のサブドメインでAPIエンドポイントを公開できます。 最後に、API platformの今後のアップグレードは、このバージョンのAPIコレクションを基盤とします。 新機能を利用するには、このAPIコレクションをアップグレードします。
WARNING
このアクションは元に戻せないことに注意してください。 APIプレフィックスを使用するようにAPIコレクションをアップグレードすると、以前のURLに戻すことはできません。 この変更について、このAPIを使用している既存のすべてのクライアントに通知する準備をしておく必要があります。
APIコレクションをアップグレードする方法
たとえば、このAPIコレクションではAPIプレフィックスが有効化されていません。 APIコレクションをアップグレードするプロセスを説明します。
APIコレクションをアップグレードするには、次の手順を完了します:
APIコレクションのSettingsタブに移動します。
Start upgradeを選択します。
アップグレードの注意事項を読み、Start upgradeを選択します。
アップグレードが完了しました。 このAPIコレクション内のすべてのエンドポイントで、APIプレフィックスが有効になりました。
次に、まだ実施していない場合は、このAPIコレクションの既存ユーザーに通知します。
Last updated: