カスタムドメイン
カスタムドメインを設定することで、API開発者ポータルのエクスペリエンスをパーソナライズできます。 これにより、ブランド化されたURLでポータルを提供でき、開発者がドキュメントやテストエンドポイントにアクセスする際の信頼性と一貫性が向上します。
CNAMEレコードの設定
カスタムドメインを設定するには、DNS設定にCNAMEレコードを追加する必要があります。 これらのレコードは異なるDNS名に適用する必要があります。 たとえば、portal.example.comにはCNAMEを使用し、example.comなどのルートドメインには他のDNSレコードを予約します。 ほとんどのDNSプロバイダーでは、同じサブドメインでCNAMEと他のレコードタイプを使用できません。
機能の提供状況
API platformのカスタムドメインは、中国データセンターではサポートされていません。 これは現地の規制要件を反映したものであり、当社のマルチテナントおよびVirtual Private Workato(VPW)サービスに適用されます。
カスタムドメイン
カスタムドメインを使用すると、組織のドメインでAPI Developer Portalをホストできます。 これにより、デフォルトのWorkatoホストURLが、https://portal.example.comのようなブランド化されたURLに置き換えられます。
DNS設定を構成することで、開発者はデフォルトのWorkatoドメイン({customer_subdomain}.portal.app.workato.com)ではなく、ブランド化されたドメインからポータルとAPIドキュメントにアクセスできます。
カスタムドメインは{subdomain}.{your_domain}形式に従います。 例:
https://portal.idea-lifestyle.netTLSの証明書
Workatoは、カスタムドメイン用のHTTPS証明書をLet’s Encryptを通じて発行および管理します。 証明書は有効期限の1か月前に自動的に更新されます。
認証局承認(CAA)レコード
DNSでドメインの証明書を発行できる認証局を制限している場合は、letsencrypt.orgのCAAレコードを追加します。
カスタムドメインの設定
前提条件
カスタムドメインを設定する前に、次のものがあることを確認します。
- DNSホストへのアクセス
- 登録済みのドメイン名とサブドメイン名。 ドメイン名の詳細については、ICANNドキュメントを参照してください。 たとえば、
portal.boltcompany.comです。
VIRTUAL PRIVATE WORKATO (VPW)のお客様
この機能を使用するには、お使いのVirtual Private Workato(VPW)インスタンスに固有の設定手順が必要です。 VPWをご利用のお客様は、インスタンスの設定詳細について、VPWのプライベートドキュメントを参照してください。
API Developer Portal用のカスタムドメインを設定するには、次の手順を実行します。
Workatoアカウントにサインインします。
プラットフォーム > API platform > 設定 > Developer Portal > カスタムドメインに移動します。
ドメインを追加をクリックします。
カスタムドメインを追加
完全なサブドメインを入力し、ドメインを追加をクリックします。 たとえば、portal.example.comです。
完全なサブドメインを入力
使用中のドメイン名
異なるWorkato Environmentまたは機能間で同じサブドメインを使用することはできません。 競合を避けるために、別のサブドメインを使用します。
DNSプロバイダーの管理コンソールでCNAMEレコードを作成して、ドメインを検証します。
DNSプロバイダーのDNS管理コンソールを開きます。
サブドメイン用の新しいCNAMEレコードを追加し、Workatoのカスタムドメイン設定に表示されるターゲットの値に指定します。 たとえば、abcde123456.apim-portal-custom.workato.comです。
DNSレコードを保存します。
保存をクリックします。
CNAMEレコードが伝播するまで最大24時間かかる場合があります。 DNS検証後、Workatoはドメイン用のSSL証明書を発行して適用します。 証明書の生成には最大1時間かかる場合があります。 ステータスを確認するには、カスタムドメインページを更新します。
カスタムドメインの削除
カスタムドメインを削除するには、次の手順を実行します。
カスタムドメインエントリの横にある削除をクリックします。
モーダルダイアログでアクションを確認し、デフォルトのWorkatoドメインに戻します。
カスタムドメインを削除
Last updated: